https://github.com/agoose77/markdown-it-mermaid
A markdown-it plugin for MermaidJS
https://github.com/agoose77/markdown-it-mermaid
diagram flowchart graph markdown markdown-it mermaidjs
Last synced: 13 days ago
JSON representation
A markdown-it plugin for MermaidJS
- Host: GitHub
- URL: https://github.com/agoose77/markdown-it-mermaid
- Owner: agoose77
- License: other
- Created: 2022-04-14T12:45:03.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-22T06:13:22.000Z (over 2 years ago)
- Last Synced: 2025-03-27T05:25:05.000Z (about 1 month ago)
- Topics: diagram, flowchart, graph, markdown, markdown-it, mermaidjs
- Language: TypeScript
- Homepage:
- Size: 146 KB
- Stars: 8
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown-it-mermaid
[![npm-badge]][npm] [![docs-badge]][docs]
[docs-badge]:
https://readthedocs.org/projects/markdown-it-mermaid/badge/?style=for-the-badge
[docs]: https://markdown-it-mermaid.rtfd.io
[npm-badge]:
https://img.shields.io/npm/v/@agoose77/markdown-it-mermaid?style=for-the-badge
[npm]: https://www.npmjs.com/package/@agoose77/markdown-it-mermaid
[mermaidjs](https://github.com/knsv/mermaid) renderer for
[markdown-it](https://github.com/markdown-it/markdown-it).
An example mermaid diagram:
````
``` mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
````
produces
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
For more, information and a live demo, see the [documentation][docs] on ReadTheDocs.