2.0.3 • Published 4 years ago

mermaiddown v2.0.3

Weekly downloads
12
License
MIT
Repository
github
Last release
4 years ago

Mermaiddown

Mermaiddown is a node API that can be used to add inline mermaid diagrams to Markdown.

Inspired by the amazing concepts underlying the visual studio plugin Markdown Preview Mermaid Support.

Was originally hoping to embed the SVGs directly so the links worked ... seems like you can't do that on github :(

Example Diagram

Usage

See example.ts. Fenced areas meeting this form are used:

    ```mermaid
    %%%% Example Diagram    %%%%
    %%%% assets/example.svg %%%%
    graph TD;
        a["mermaiddown"];
        click a "#mermaiddown";
        b["is"];
        c["cool!"];

        a --> b;
        b --> c;
    ````

Configuration

mermaiddown just wraps mermaid.cli, so the options are the same. Use -h to see them.

In this case, the title of the image becomes 'Example Diagram', and it is rendered to assets/example.svg.

2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago