mariliaribeiro / mermaid-diagrams

Extension to enable sequence diagrams in wiki pages using mermaid syntax

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mermaid-diagrams

A simple chrome extension to add support for mermaid syntax in github pages.

For example add this to any wiki page or markdown file in github

Example 1

sequenceDiagram
  A->> B: Query
  B->> C: Forward query
  Note right of C: Thinking...
  C->> B: Response
  B->> A: Forward response
Loading

Example 2

sequenceDiagram
  A->> B: Query B
  B->> C: Forward query B
  Note right of C: Thinking of B...
  C->> B: Response of B
  B->> A: Forward response of B
Loading

This will generate a nice diagram if loaded from github. The extension will just replace the code block with the generated mermaid diagram.

Instructions to install it

Just click the link above and follow the instructions

From source

  1. Enable developer mode in chrome://extensions
  2. Clone the repo
    git clone https://github.com/Redisrupt/mermaid-diagrams
  3. Click on load unpacked extension
  4. Select the extensions folder inside the recently cloned repo

Done!

Navigate to any page in github with mermaid syntax blocks to see the extension in action

About

Extension to enable sequence diagrams in wiki pages using mermaid syntax


Languages

Language:JavaScript 56.3%Language:CSS 43.7%