Skip to content
A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation.
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
media
src
test
.all-contributorsrc
.bettercodehub.yml
.editorconfig
.gitignore
.npmignore
.prettierignore
.prettierrc.json
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
jest.config.js
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

GitHub Action CodeFactor npm version FOSSA Status tested with jest code style: prettier License: MIT typedoc-plugin-mermaid Dev Token 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 annotation

/**
 * 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 { }

↓↓ DEMO ↓↓

Example

Contributors

Thanks goes to these wonderful people (emoji key):


Yuki Yamazaki

🤔 💻 ⚠️ 📖

Bob Kerns

🐛

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

You can’t perform that action at this time.