# typedoc-plugin-mermaid > A plugin for TypeDoc that generates graphs for mermaid.js diagrams by using @mermaid annotation. Latest version **1.12.0** (published 2024-07-04) · MIT license · 0 weekly downloads ## Install ```sh npm install typedoc-plugin-mermaid pnpm add typedoc-plugin-mermaid yarn add typedoc-plugin-mermaid bun add typedoc-plugin-mermaid ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: esm support; no vulnerabilities; has provenance. Warnings: low downloads; no types. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.12.0 | | Published | 2024-07-04 | | First published | 2019-03-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | ESM + CommonJS | | Node | >=16.0.0 | | Dependencies | 1 | | Unpacked size | 20.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 33 | | Author | kamiazya | | Maintainers | kamiazya | | Keywords | typedoc, typedocplugin, mermaid, graph, diagram | ## Links - npm: https://www.npmjs.com/package/typedoc-plugin-mermaid - Repository: https://github.com/kamiazya/typedoc-plugin-mermaid - Homepage: https://kamiazya.github.io/typedoc-plugin-mermaid/ - Issues: https://github.com/kamiazya/typedoc-plugin-mermaid/issues - Funding: https://github.com/sponsors/kamiazya - npm.io page: https://npm.io/package/typedoc-plugin-mermaid ## Dependencies (1) - [html-escaper](https://npm.io/package/html-escaper.md) ^3.0.3 ## Alternatives - [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads - [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads - [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads - [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads - [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads ## Recent versions - 1.12.0 (latest) — 2024-07-04 - 1.12.0-next-593b8a2f395c7876f215602d42fe3e7f527be062 (next) — 2024-07-04 - 1.11.0-pr856-7942c5409ceab387fd5f0baaf07be1f51816819c (develop) — 2024-06-13 - 1.12.0-next-22e4f914255814441ed434b4d3f223f2c02375be — 2024-07-04 - 1.12.0-next-f5c7748d3007b69bdab3bbd7dfe5b636087e2193 — 2024-07-04 - 1.12.0-next-70b7cd5743e6655c7a1e3735c280e9d1a622aa6a — 2024-07-04 - 1.11.1 — 2024-06-13 - 1.11.1-next-e99c94a839521a1f5d0b681366589c14ce101be5 — 2024-06-13 - 1.11.1-next-26838095b3732860dfdf594c6f77583b19a04090 — 2024-06-13 - 1.11.0 — 2024-06-13 - 1.11.0-next-90cf89e49123a2a5616bed6e0ca7fc4eed7d6538 — 2024-06-13 - 1.11.0-next-1bd966a578c41b0ff294dd166d12bfbab22b5369 — 2024-06-13 - 1.11.0-next-e6a50a8d026d5d65b37adba9592a14ae726ab585 — 2024-06-13 - 1.11.0-pr854-de270da3a18dde19c81673a596120cbb90e8a08b — 2024-06-13 - 1.11.0-pr854-968455152f2c62bd70de7481d8d6dd60121b66d0 — 2024-06-13 - … 23 more at https://npm.io/package/typedoc-plugin-mermaid/versions ## README [![GitHub Action](https://github.com/kamiazya/typedoc-plugin-mermaid/workflows/Node%20CI/badge.svg)](https://github.com/kamiazya/typedoc-plugin-mermaid/actions?workflow=Node+CI) [![CodeFactor](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-mermaid/badge)](https://www.codefactor.io/repository/github/kamiazya/typedoc-plugin-mermaid) [![npm version](https://badge.fury.io/js/typedoc-plugin-mermaid.svg)](https://badge.fury.io/js/typedoc-plugin-mermaid) ![node version](https://img.shields.io/node/v/typedoc-plugin-mermaid) ![npm](https://img.shields.io/npm/dm/typedoc-plugin-mermaid) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkamiazya%2Ftypedoc-plugin-mermaid.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkamiazya%2Ftypedoc-plugin-mermaid?ref=badge_shield) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) [![All Contributors](https://img.shields.io/github/all-contributors/kamiazya/typedoc-plugin-mermaid?color=ee8449)](#contributors) [![format: Biome](https://img.shields.io/badge/format%20with-Biome-F7B911?logo=biome&style=flat)](https://biomejs.dev/) [![test: Vitest](https://img.shields.io/badge/tested%20with-Vitest-6E9F18?logo=vitest&style=flat)](https://vitest.dev/) [![build: Vite](https://img.shields.io/badge/build%20with-Vite-646CFF?logo=vite&style=flat)](https://rollupjs.org/) # 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](https://www.npmjs.com/): [![NPM](https://nodei.co/npm/typedoc-plugin-mermaid.png)](https://nodei.co/npm/typedoc-plugin-mermaid/) ```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 ↓↓](https://kamiazya.github.io/typedoc-plugin-samples/classes/hoge.html) [![Example](https://github.com/kamiazya/typedoc-plugin-mermaid/raw/main/media/example.png)](https://kamiazya.github.io/typedoc-plugin-samples/classes/hoge.html) ### Arguments 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](https://allcontributors.org/docs/en/emoji-key)):
Yuki Yamazaki
Yuki Yamazaki
🤔 💻 ⚠️ 📖		 Bob Kerns
Bob Kerns
🐛 💻		 Emily Marigold Klassen
Emily Marigold Klassen
💻 ⚠️		 Mathieu Jalbert-Claveau
Mathieu Jalbert-Claveau
🐛		 Michael Schmidt
Michael Schmidt
💻 ⚠️ 📖		 Carl Fürstenberg
Carl Fürstenberg
🐛 🚇		 Will Henderson
Will Henderson
💻 🐛 💡
guryanovev
guryanovev
🐛		 Ricardo Ferreira
Ricardo Ferreira
🤔		 Maneet Goyal
Maneet Goyal
🤔		 Juergen Zimmermann
Juergen Zimmermann
🐛		 Michal Kindl
Michal Kindl
️️️️♿️		 Ludovic Muller
Ludovic Muller
️️️️♿️
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## License This software is released under the MIT License, see [LICENSE](./LICENSE). [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fkamiazya%2Ftypedoc-plugin-mermaid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fkamiazya%2Ftypedoc-plugin-mermaid?ref=badge_large) --- _Source: https://npm.io/package/typedoc-plugin-mermaid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._