Gathering detailed insights and metrics for jsdoc-to-markdown
Gathering detailed insights and metrics for jsdoc-to-markdown
Generate markdown documentation from jsdoc-annotated javascript
Installations
npm install jsdoc-to-markdownDeveloper
jsdoc2md
Developer Guide
BETA
Module System
ESM
Min. Node Version
>=12.17
Typescript Support
No
Node Version
23.1.0
NPM Version
10.9.0
Statistics
1,692 Stars
1,036 Commits
152 Forks
15 Watching
2 Branches
8 Contributors
Updated on 19 Nov 2024
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
29,898,228
Last day
-30.2%
41,174
Compared to previous day
Last week
-2.6%
268,540
Compared to previous week
Last month
55.7%
989,184
Compared to previous month
Last year
14.7%
7,284,590
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
8
Peer Dependencies
1
Versions
Upgraders, please read the release notes
jsdoc-to-markdown
Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.
Synopsis
1. Document your code using valid jsdoc comments.
1/** 2 * A quite wonderful function. 3 * @param {object} - Privacy gown 4 * @param {object} - Security 5 * @returns {survival} 6 */ 7function protection (cloak, dagger) {}
2. Run a command.
1$ jsdoc2md example.js
3. Get markdown output.
1## protection(cloak, dagger) ⇒ <code>survival</code> 2A quite wonderful function. 3 4**Kind**: global function 5 6| Param | Type | Description | 7| ------ | ------------------- | ------------ | 8| cloak | <code>object</code> | Privacy gown | 9| dagger | <code>object</code> | Security | 10
Install
$ npm install --save-dev jsdoc-to-markdown
See also
- API documentation
- The wiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.
© 2014-24 Lloyd Brookes <opensource@75lb.com>.
Tested by test-runner.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
30 commit(s) and 15 issue activity found in the last 90 days -- score normalized to 10
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc2md/jsdoc-to-markdown/node.js.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/jsdoc2md/jsdoc-to-markdown/node.js.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:29
- Warn: npmCommand not pinned by hash: .github/workflows/node.js.yml:30
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Info: no jobLevel write permissions found
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Score
4.4
/10
Last Scanned on 2024-11-18
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