mercat

A browser extension for chrome that renders Mermaid diagrams inline in markdown documents hosted on github.com.

Using Mermaid over images of your diagrams (png, jpg, etc.) in your markdown documents has the advantage that you can easily review any changes that are made to the diagram; they will appear as any other diff in your PRs. However, the problem is that the GitHub Flavored Markdown will not render your diagram. This kind of defeats the purpose of using Mermaid.

This extension solves that dilemma by scanning your markdown documents for Mermaid code blocks and replacing them with the actual diagrams. So you can keep reaping the benefits from diagrams-as-code yet get beautiful rendered diagrams when you read and share your markdown document on Github.

Etymology of the word Mer•cat:

It is just a contraction of the words "Mermaid", the name of the tool powering this feature, and "OctoCat", the Github mascot.