Skip to content

kamiazya/typedoc-plugin-mermaid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jul 16, 2022
7d70273 Β· Jul 16, 2022
Jul 16, 2022
Jul 22, 2021
Jul 16, 2022
Mar 8, 2019
Jul 16, 2022
Apr 6, 2022
Jul 16, 2022
Mar 8, 2019
Feb 5, 2020
Jul 22, 2021
Jul 22, 2021
Mar 7, 2019
Feb 5, 2020
Jul 22, 2021
Jul 22, 2021
Feb 5, 2020
Feb 6, 2020
Mar 7, 2019
Jul 16, 2022
Feb 5, 2020
Jul 16, 2022
Oct 24, 2021
Oct 25, 2021
Jul 16, 2022

Repository files navigation

GitHub Action CodeFactor npm version FOSSA Status tested with jest code style: prettier License: MIT BCH compliance PRs Welcome 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

Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

$ typedoc --help
...
Options:
 --mermaidVersion            [Mermaid Plugin] The version of mermaid.js to use.
...
  • --mermaidVersion

    Specify mermaid.js version to use.

    Default: latest, Example: 8.14.0

Contributors

Thanks goes to these wonderful people (emoji key):


Yuki Yamazaki

πŸ€” πŸ’» ⚠️ πŸ“–

Bob Kerns

πŸ›

Emily Marigold Klassen

πŸ’» ⚠️

Mathieu Jalbert-Claveau

πŸ›

Michael Schmidt

πŸ’» ⚠️ πŸ“–

Carl FΓΌrstenberg

πŸ› πŸš‡

Will Henderson

πŸ’» πŸ› πŸ’‘

guryanovev

πŸ›

Ricardo Ferreira

πŸ€”

Maneet Goyal

πŸ€”

Juergen Zimmermann

πŸ›

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