Gathering detailed insights and metrics for documentation
Gathering detailed insights and metrics for documentation
:book: documentation for modern JavaScript documentation for modern JavaScript
Installations
npm install documentationDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
>=14
Node Version
18.18.0
NPM Version
9.8.1
Releases
19
Languages
4
JavaScript
CSS
Vue
Shell
JavaScript (95.88%)
CSS (4.01%)
Vue (0.09%)
Shell (0.02%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
NOASSERTION License
5,791 Stars
1,373 Commits
488 Forks
55 Watchers
17 Branches
134 Contributors
Updated on Jul 09, 2025
Maintainers
5
Package Meta Information
Latest Version
14.0.3
Package Id
documentation@14.0.3
Unpacked Size
1.79 MB
Size
1.25 MB
File Count
108
NPM Version
9.8.1
Node Version
18.18.0
Published on
Jan 30, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
37
@babel/core@babel/generator@babel/parser@babel/traverse@babel/typeschalkchokidardiffdoctrine-temporary-forkgit-url-parsegithub-sluggerglobglobals-docshighlight.jsinijs-yamlkonanlodashmdast-util-find-and-replacemdast-util-injectmicromark-util-characterparse-filepathpifyread-pkg-upremarkremark-gfmremark-htmlremark-reference-linksremark-tocresolvestrip-json-commentsunist-builderunist-util-visitvfilevfile-reportervfile-sortyargs
Dev Dependencies
14
Optional Dependencies
2
The documentation system for modern JavaScript
:date: Current maintenance status
- Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations.
- Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
- Integrates with GitHub to link directly from documentation to the code it refers to.
- Customizable output: HTML, JSON, Markdown, and more
Examples
Documentation
- Getting Started: start here
- Usage: how to use documentation.js
- Recipes: tricks for writing effective JSDoc docs
- Node API: documentation.js's self-generated documentation
- Configuring documentation.js
- FAQ
- Troubleshooting
- Theming: tips for theming documentation output in HTML
- See also: a list of projects similar to documentation.js
User Guide
Globally install documentation using the npm package manager:
1$ npm install -g documentation
This installs a command called documentation in your path, that you can
point at JSDoc-annotated source code to generate
human-readable documentation. First, run documentation with the --help
option for help:
1Usage: 2 3# generate markdown docs for index.js and files it references 4documentation build index.js -f md 5 6# generate html docs for all files in src, and include links to source files in github 7documentation build src/** -f html --github -o docs 8 9# document index.js, ignoring any files it requires or imports 10documentation build index.js -f md --shallow 11 12# validate JSDoc syntax in util.js 13documentation lint util.js 14 15# update the API section of README.md with docs from index.js 16documentation readme index.js --section=API 17 18# build docs for all values exported by index.js 19documentation build --document-exported index.js 20 21# build html docs for a TypeScript project 22documentation build index.ts --parse-extension ts -f html -o docs 23 24Commands: 25 build [input..] build documentation 26 lint [input..] check for common style and uniformity mistakes 27 readme [input..] inject documentation into your README.md 28 29Options: 30 --version Show version number [boolean] 31 --help Show help [boolean]
Contributing
We have plenty of issues that we'd love help with.
- Robust and complete
JSDocsupport, including typedefs. - Strong support for HTML and Markdown output
- Documentation coverage, statistics, and validation
documentation is an OPEN Open Source Project. This means that:
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
Found 13/18 approved changesets -- score normalized to 7
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 1 commits out of 26 are checked with a SAST tool
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/documentationjs/documentation/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/documentationjs/documentation/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/documentationjs/documentation/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/documentationjs/documentation/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/documentationjs/documentation/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/documentationjs/documentation/node.js.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
1 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Info: no jobLevel write permissions found
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
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'
Score
4.3
/10
Last Scanned on 2025-07-07
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