vuepress-plugin-mermaidjs

    1.8.1 • Public • Published

    npm version Build Status

    VuePress Plugin for mermaid.js

    Use mermaid.js Diagrams in VuePress

    This VuePress plugin provides a global component wrapping mermaid.js. The plugin is designed to work with VuePress v1.x.

    Main documentation site is at vuepress-plugin-mermaidjs.efrane.com.

    Installation

    You can install it with

    yarn add -D vuepress-plugin-mermaidjs

    or

    npm install --save-dev vuepress-plugin-mermaidjs

    Then you just need to register the plugin in your .vuepress/config.js:

    module.exports = {
        // ...
        plugins: [
            'vuepress-plugin-mermaidjs'
        ]
        // ...
    }

    Usage

    The recommended usage is to place your mermaidjs diagrams inside a fenced code block with the language 'mermaid':

    ```mermaid
    sequenceDiagram
    Alice->John: Hello John, how are you?
    loop every minute
        John-->Alice: Great!
    end
    ```
    

    Install

    npm i vuepress-plugin-mermaidjs

    DownloadsWeekly Downloads

    1,644

    Version

    1.8.1

    License

    MIT

    Unpacked Size

    10.9 kB

    Total Files

    11

    Last publish

    Collaborators

    • efrane