!node version
!npm

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:


``sh


npm

npm install --save-dev typedoc-plugin-mermaid

or yarn

yarn add -D typedoc-plugin-mermaid
`

Add this plugin in your typedoc.json:

`json
{
"plugin": ["typedoc-plugin-mermaid"]
}
`

If you use the @mermaid tag in your tsdoc comments,
add typedoc-plugin-mermaid/tsdoc.json to the extends of tsdoc.json:

`json
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"extends": [
"typedoc-plugin-mermaid/tsdoc.json"
]
}
`

Usage

Write tsdoc with @mermaid annotations:

`typescript
/**
* 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:

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

↓↓ DEMO ↓↓

![Example](https://kamiazya.github.io/typedoc-plugin-samples/classes/hoge.html)

$3

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

`bash
$ 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 🐛	Michal Kindl ️️️️♿️	Ludovic Muller ️️️️♿️

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

License

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