A documentation generation system that's beautiful by default, flexible across formats and styles, and powerful enough to support JSDoc's advanced syntax.
Support for C++
You can use the
--polyglot mode of documentationjs to document native node.js
modules in JSDoc within the C++ code that implements the feature.
Support for following dependency trees
require() graphs - pointing it to your app's
main file will find all
referenced files and include all of their documentation.
--github option automatically permalinks documentation to the exact
sections of code it refers to in a GitHub repository.
documentation using the npm package manager:
$ 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
option for help:
Usage:# generate markdown docs for index.js and files it referencesbin/documentation.js build index.js -f md# generate html docs for all files in srcbin/documentation.js build src/** -f html -o docs# document index.js, ignoring any files it requires or importsbin/documentation.js build index.js -f md --shallow# build, serve, and live-update html docs for app.jsbin/documentation.js serve app.js# validate JSDoc syntax in util.jsbin/documentation.js lint util.js# update the API section of README.md with docs from index.jsbin/documentation.js readme index.js --section=API# build docs for all values exported by index.jsbin/documentation.js build --document-exported index.jsCommands:serve [input..] generate, update, and display HTML documentationbuild [input..] build documentationlint [input..] check
We have plenty of issues that we'd love help with.
JSDocsupport, 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.