README
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 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 { }
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.