Skip to content

A plugin to render mermaid diagrams in docsify

Notifications You must be signed in to change notification settings

ediphy-dcottrell/mermaid-docsify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mermaid-docsify is a docsify plugin which allows to render mermaid diagrams in docsify.

How to use

Add Mermaid and the plugin:

<script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
<script src="//unpkg.com/docsify-mermaid@latest/dist/docsify-mermaid.js"> 
<script>mermaid.initialize({ startOnLoad: true });</script>

Now you can include mermaid diagrams in your docsify docs:

```mermaid
graph LR
    A --- B
    B-->C[fa:fa-ban forbidden]
    B-->D(fa:fa-spinner);
```

A demo is available on Codepen.

Docsify with mermaid Screenshot

About

A plugin to render mermaid diagrams in docsify

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 55.6%
  • HTML 44.4%