package
a documentation generator
npm install documentationGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Latest published Jan 30, 2024
latest
alpha
The documentation system for modern JavaScript
:date: Current maintenance status
Globally install documentation using the npm package manager:
$ npm install -g documentationThis 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:
Usage:
# generate markdown docs for index.js and files it references
documentation build index.js -f md
# generate html docs for all files in src, and include links to source files in github
documentation build src/** -f html --github -o docs
# document index.js, ignoring any files it requires or imports
documentation build index.js -f md --shallow
# validate JSDoc syntax in util.js
documentation lint util.js
# update the API section of README.md with docs from index.js
documentation readme index.js --section=API
# build docs for all values exported by index.js
documentation build --document-exported index.js
# build html docs for a TypeScript project
documentation
We have plenty of issues that we'd love help with.
JSDoc support, including typedefs.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.
jfirebaugh
john.firebaugh@gmail.com
Estimated unpacked size across 65 packages.
18.9 MB+
Includes dependencies.
^4.17.21
4.18.1
^14.0.2
15.0.1
^4.1.0
5.5.0
^1.22.1
1.22.14
^3.5.3
6.0.0
^3.0.1
4.0.1
^8.0.1
9.0.0
^3.0.0
4.0.0
^7.18.10
8.1.2
^9.1.0
11.0.0
^15.0.1
16.0.1
^7.18.10
8.1.2
^2.4.1
2.4.1
^11.6.0
11.12.0
^7.18.11
8.1.2
^13.1.0
16.1.0
^3.0.0
4.0.0
1.4.0
2.0.0
^1.0.2
1.0.2
^7.0.4
8.1.1
^7.18.11
8.1.2
^7.18.10
8.1.2
^4.1.0
5.2.0
^1.1.0
1.1.0
^5.0.0
5.1.0
^6.0.1
7.0.0
2.1.0
^1.1.0
2.1.1
3.0.4