现代JavaScript的文档系统。
- 支持现代JavaScript：ES5，ES2017，JSX和Flow类型注释。
- 影响参数，类型，成员资格等。 写更少的文档：让电脑为你写。
- 与GitHub集成，直接从文档链接到它引用的代码。
- 可自定义的输出：HTML，JSON，Markdown等
documentation.js
现代JavaScript的文档系统。(The documentation system for modern JavaScript. )
Github星跟蹤圖
主要指標
- 概覽
-
名稱與所有者 documentationjs/documentation 主編程語言 JavaScript 編程語言 JavaScript (語言數: 4) 平台 許可證 Other - 所有者活动
-
創建於 2015-03-10 03:34:09 推送於 2025-04-15 18:50:26 最后一次提交 2025-04-15 13:50:25 發布數 116 最新版本名稱 v14.0.3 (發布於 2024-01-30 13:48:23) 第一版名稱 v1.0.1 (發布於 2015-04-08 19:25:40) - 用户参与
-
星數 5.8k 關注者數 55 派生數 489 提交數 1.4k 已啟用問題? 問題數 804 打開的問題數 200 拉請求數 565 打開的拉請求數 11 關閉的拉請求數 283 - 项目设置
-
已啟用Wiki? 已存檔? 是復刻? 已鎖定? 是鏡像? 是私有?
: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:
$ 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]
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.