npmpackage.info

Gathering detailed insights and metrics for @rwk/typedoc-plugin-mermaid

@rwk/typedoc-plugin-mermaid - 1.9.0-test7 | npmpackage.info

@rwk/typedoc-plugin-mermaid

A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation.

1.9.0-test7

MIT

TypeScript

1.81 kB

2,295 4.7

Installations

npm install @rwk/typedoc-plugin-mermaid

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Node Version

16.19.1

NPM Version

8.19.3 Score

Supply Chain

97.9

Quality

75.4

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

10

Total

901

Closed

732

Merged

159

Issues

Open

6

Total

19

Closed

13

Releases

typedoc-plugin-mermaid@1.12.0

Updated on Jul 04, 2024

typedoc-plugin-mermaid@1.11.1

Updated on Jun 13, 2024

typedoc-plugin-mermaid@1.11.0

Updated on Jun 13, 2024

v1.10.0 🌈

v1.10.0

Updated on Mar 07, 2023

v1.9.0 🌈

v1.9.0

Updated on Jul 16, 2022

v1.8.0 🌈

v1.8.0

Updated on Apr 06, 2022

View All 16 releases

Languages

TypeScript

TypeScript (100%)

Developer

kamiazya

Download Statistics

Total Downloads

2,295

Last Day

Last Week

Last Month

Last Year

1,241

GitHub Statistics

MIT License

31 Stars

424 Commits

9 Forks

2 Watchers

19 Branches

7 Contributors

Updated on Feb 05, 2025

Bundle Size

4.17 kB

Minified

1.81 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/kamiazya

Maintainers

View All 7 Contributors

Package Meta Information

Latest Version

1.9.0-test7

Package Id

@rwk/typedoc-plugin-mermaid@1.9.0-test7

Unpacked Size

108.07 kB

Size

71.67 kB

File Count

NPM Version

8.19.3

Node Version

16.19.1

Published on

Mar 06, 2023

Total Downloads

Cumulative downloads

Total Downloads

2,295

Last Day

300%

Compared to previous day

Last Week

100%

Compared to previous week

Last Month

-14%

Compared to previous month

Last Year

53.2%

1,241

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

typedoc-plugin-mermaid

A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation. [Temp fork to be compatible with mermaid v10]

Installation

The plugin can then be installed using npm:

1# npm
2npm install --save-dev typedoc-plugin-mermaid
3# or yarn
4yarn add -D typedoc-plugin-mermaid

Usage

Write tsdoc with @mermaid annotations:

1/**
2 * Hoge is sample class for example of `typedoc-plugin-mermaid`.
3 *
4 * @mermaid Make TypeDoc easy to use with mermaid.js
5 * graph TB
6 *   mermaid.js --> TypeDoc;
7 */
8export class Hoge { }

Or use fenced code blocks:

1/**
2 * Mermaid code blocks are automatically detect and converted.
3 *
4 * ```mermaid
5 * graph TB
6 *   mermaid.js --> TypeDoc;
7 * ```
8 */
9export class Mermaid { }

↓↓ DEMO ↓↓

Arguments

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

1$ typedoc --help
2...
3Options:
4 --mermaidVersion            [Mermaid Plugin] The version of mermaid.js to use.
5...

--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} 🐛

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

License

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

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.7

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@rwk/typedoc-plugin-mermaid

Installations

Developer Guide

No

CommonJS, ESM

16.19.1

8.19.3

Score

Pull Requests

10

901

732

159

Issues

6

19

13

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

4.17 kB

1.81 kB

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

2,295

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

typedoc-plugin-mermaid

Installation

Usage

Arguments

Contributors

License

10

10

10

10

10

8

0

0

0

0

0

0

4.7

/10