Get unlimited public & private packages + team-based management with npm Teams.Learn more »

typedoc-plugin-mermaid

1.2.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 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

Install

npm i typedoc-plugin-mermaid

DownloadsWeekly Downloads

25

Version

1.2.0

License

MIT

Unpacked Size

97.7 kB

Total Files

8

Last publish

Collaborators

  • avatar