Gathering detailed insights and metrics for @rwk/typedoc-plugin-mermaid
Gathering detailed insights and metrics for @rwk/typedoc-plugin-mermaid
A plugin for TypeDoc that generates graphs for mermaid.js diagrams by @mermaid annotation.
Installations
npm install @rwk/typedoc-plugin-mermaidDeveloper Guide
BETA
Typescript
No
Module System
CommonJS, ESM
Node Version
16.19.1
NPM Version
8.19.3
Score
61
Supply Chain
97.9
Quality
75.4
Maintenance
100
Vulnerability
99.3
License
Releases
16
typedoc-plugin-mermaid@1.12.0
typedoc-plugin-mermaid@1.12.0
Updated on Jul 04, 2024
typedoc-plugin-mermaid@1.11.1
typedoc-plugin-mermaid@1.11.1
Updated on Jun 13, 2024
typedoc-plugin-mermaid@1.11.0
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
Languages
1
TypeScript
TypeScript (100%)
Developer
Download Statistics
Total Downloads
2,295
Last Day
4
Last Week
12
Last Month
43
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
Sponsor this package
Maintainers
1
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
9
NPM Version
8.19.3
Node Version
16.19.1
Published on
Mar 06, 2023
Total Downloads
Cumulative downloads
Total Downloads
2,295
Dependencies
1
Peer Dependencies
1
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 { }
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 binaries found in the repo
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 dangerous workflow patterns detected
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
Found 0/14 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
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
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
19 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- 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-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
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