Installations
npm install typedoc-plugin-mermaidDeveloper Guide
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
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 🌈
Published on 07 Mar 2023
v1.9.0 🌈
Published on 16 Jul 2022
v1.8.0 🌈
Published on 06 Apr 2022
Contributors
Languages
TypeScript (100%)
Developer
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
Sponsor this package
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
6
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
Dependencies
1
Peer Dependencies
1
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 { }
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...
-
--mermaidVersionSpecify mermaid.js version to use.
Default:
latest, Example:8.14.0
Contributors
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
License
This software is released under the MIT License, see LICENSE.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no binaries found in the repo
Reason
all dependencies are pinned
Details
- Info: 17 out of 17 GitHub-owned GitHubAction dependencies pinned
- Info: 5 out of 5 third-party GitHubAction dependencies pinned
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
SAST tool is not run on all commits -- score normalized to 8
Details
- Warn: 23 commits out of 26 are checked with a SAST tool
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/14 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:47
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:74
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:89
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/cicd.yaml:125
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:152
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:17
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/cicd.yaml:32
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/pr-snapshot-release-command.yaml:15
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/pr-snapshot-release-command.yaml:37
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/pr-snapshot-release-command.yaml:57
- Warn: no topLevel permission defined: .github/workflows/cicd.yaml:1
- Warn: no topLevel permission defined: .github/workflows/pr-snapshot-release-command.yaml:1
- Warn: no topLevel permission defined: .github/workflows/update-license-year.yaml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
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