typedoc-plugin-mermaid

    1.6.0 • Public • Published

    GitHub Action CodeFactor npm version FOSSA Status tested with jest code style: prettier License: MIT typedoc-plugin-mermaid Dev Token BCH compliance PRs Welcome Open in Visual Studio Code All Contributors

    typedoc-plugin-mermaid

    A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation.

    Installation

    The plugin can then be installed using npm:

    NPM

    # npm
    npm install --save-dev typedoc-plugin-mermaid
    # or yarn
    yarn add -D typedoc-plugin-mermaid

    Usage

    Write tsdoc with @mermaid annotations:

    /**
     * Hoge is sample class for example of `typedoc-plugin-mermaid`.
     *
     * @mermaid Make TypeDoc easy to use with mermaid.js
     * graph TB
     *   mermaid.js --> TypeDoc;
     */
    export class Hoge { }

    Or use fenced code blocks:

    /**
     * Mermaid code blocks are automatically detect and converted.
     *
     * ```mermaid
     * graph TB
     *   mermaid.js --> TypeDoc;
     * ```
     */
    export class Mermaid { }

    ↓↓ DEMO ↓↓

    Example

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Yuki Yamazaki

    🤔 💻 ⚠️ 📖

    Bob Kerns

    🐛

    Emily Marigold Klassen

    💻 ⚠️

    Mathieu Jalbert-Claveau

    🐛

    Michael Schmidt

    💻 ⚠️ 📖

    Carl Fürstenberg

    🐛 🚇

    This project follows the all-contributors specification. Contributions of any kind welcome!

    License

    This software is released under the MIT License, see LICENSE.

    FOSSA Status

    Install

    npm i typedoc-plugin-mermaid

    DownloadsWeekly Downloads

    1,381

    Version

    1.6.0

    License

    MIT

    Unpacked Size

    112 kB

    Total Files

    10

    Last publish

    Collaborators

    • kamiazya