npmpackage.info

Gathering detailed insights and metrics for typedoc-plugin-mermaid

Other packages similar to typedoc-plugin-mermaid

@rwk/typedoc-plugin-mermaid

1.9.0-test7

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

typedoc-plugin-mermaid

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

1.12.0

MIT

TypeScript

1.70 kB

456,694 4.8

Installations

npm install typedoc-plugin-mermaid

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Min. Node Version

>=16.0.0

Node Version

20.15.0

NPM Version

10.7.0 Score

62.4

Supply Chain

98.5

Quality

84.2

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

10

Total

901

Closed

732

Merged

159

Issues

Open

4

Total

17

Closed

13

Releases

typedoc-plugin-mermaid@1.12.0

Published on 04 Jul 2024

typedoc-plugin-mermaid@1.11.1

Published on 13 Jun 2024

typedoc-plugin-mermaid@1.11.0

Published on 13 Jun 2024

v1.10.0 🌈

v1.10.0

Published on 07 Mar 2023

v1.9.0 🌈

v1.9.0

Published on 16 Jul 2022

v1.8.0 🌈

v1.8.0

Published on 06 Apr 2022

View all 16 releases

Contributors

View all 7 contributors

Languages

TypeScript

TypeScript (100%)

Developer

kamiazya

Download Statistics

Total Downloads

456,694

Last Day

182

Last Week

831

Last Month

12,306

Last Year

135,088

GitHub Statistics

30 Stars

424 Commits

9 Forks

3 Watching

19 Branches

7 Contributors

Bundle Size

3.89 kB

Minified

1.70 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/kamiazya

Maintainers

Package Meta Information

Latest Version

1.12.0

Package Id

typedoc-plugin-mermaid@1.12.0

Unpacked Size

20.49 kB

Size

6.26 kB

File Count

NPM Version

10.7.0

Node Version

20.15.0

Publised On

04 Jul 2024

Total Downloads

Cumulative downloads

Total Downloads

456,694

Last day

-46.5%

182

Compared to previous day

Last week

-70.5%

831

Compared to previous week

Last month

-8.2%

12,306

Compared to previous month

Last year

12.2%

135,088

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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:

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

Add this plugin in your typedoc.json:

1{
2  "plugin": ["typedoc-plugin-mermaid"]
3}

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

1{
2  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3  "extends": [
4    "typedoc-plugin-mermaid/tsdoc.json"
5  ]
6}

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} 🐛	_{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.

Fuzzing

Determines if the project uses fuzzing.

Score

4.8

/10

Last Scanned on 2025-01-06

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

Other packages similar to typedoc-plugin-mermaid

typedoc-plugin-mermaid

Installations

Developer Guide

No

CommonJS, ESM

>=16.0.0

20.15.0

10.7.0

Score

Pull Requests

10

901

732

159

Issues

4

17

13

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

3.89 kB

1.70 kB

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

456,694

Daily Downloads

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

1

0

0

0

0

0

4.8

/10