现代JavaScript的文档系统。
- 支持现代JavaScript:ES5,ES2017,JSX和Flow类型注释。
- 影响参数,类型,成员资格等。 写更少的文档:让电脑为你写。
- 与GitHub集成,直接从文档链接到它引用的代码。
- 可自定义的输出:HTML,JSON,Markdown等
现代JavaScript的文档系统。(The documentation system for modern JavaScript. )
现代JavaScript的文档系统。
Name With Owner | documentationjs/documentation |
---|---|
Primary Language | JavaScript |
Program language | JavaScript (Language Count: 4) |
Platform | |
License: | Other |
Release Count | 116 |
Last Release Name | v14.0.3 (Posted on 2024-01-30 13:48:23) |
First Release Name | v1.0.1 (Posted on 2015-04-08 19:25:40) |
Created At | 2015-03-10 03:34:09 |
Pushed At | 2024-04-29 22:16:04 |
Last Commit At | 2024-02-01 09:45:43 |
Stargazers Count | 5.8k |
Watchers Count | 59 |
Fork Count | 483 |
Commits Count | 1.4k |
Has Issues Enabled | |
Issues Count | 797 |
Issue Open Count | 195 |
Pull Requests Count | 563 |
Pull Requests Open Count | 11 |
Pull Requests Close Count | 267 |
Has Wiki Enabled | |
Is Archived | |
Is Fork | |
Is Locked | |
Is Mirror | |
Is Private |
:date: Current maintenance status
Globally install 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 --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
documentation build src/** -f html -o docs
# document index.js, ignoring any files it requires or imports
documentation build index.js -f md --shallow
# build and serve HTML docs for app.js
documentation serve app.js
# build, serve, and live-update HTML docs for app.js
documentation serve --watch app.js
# 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
Commands:
serve [input..] generate, update, and display HTML documentation
build [input..] build documentation
lint [input..] check for common style and uniformity mistakes
readme [input..] inject documentation into your README.md
Options:
--version Show version number [boolean]
--help Show help [boolean]
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.