Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/documentationjs/documentation
:book: documentation for modern JavaScript
https://github.com/documentationjs/documentation
babel documentation documentation-tool javascript jsdoc
Last synced: 5 days ago
JSON representation
:book: documentation for modern JavaScript
- Host: GitHub
- URL: https://github.com/documentationjs/documentation
- Owner: documentationjs
- License: other
- Created: 2015-03-10T03:34:09.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T22:16:04.000Z (9 months ago)
- Last Synced: 2024-10-29T21:51:16.763Z (3 months ago)
- Topics: babel, documentation, documentation-tool, javascript, jsdoc
- Language: JavaScript
- Homepage: http://documentation.js.org/
- Size: 7.22 MB
- Stars: 5,791
- Watchers: 57
- Forks: 481
- Open Issues: 209
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - documentation - :book: documentation for modern JavaScript (JavaScript)
- awesome-nodejs-cn - documentation.js - 支持 ES2015+ 和流程注释的 API 文档生成器 (包 / 文档相关)
- awesome-nodejs - documentation.js - API documentation generator with support for ES2015+ and flow annotation.  (Repository / Documentation)
- awesome-list - documentation
- awesome-nodejs - documentation.js - API documentation generator with support for ES2015+ and flow annotation. (Packages / Documentation)
- awesome-nodejs - documentation - documentation for modern JavaScript - ★ 4132 (Documentation)
- awesome-remark - documentation.js - Documentation system for modern JavaScript. (Built on remark)
- awesome-node - documentation.js - API documentation generator with support for ES2015+ and flow annotation. (Packages / Documentation)
- awesome-nodejs-cn - documentation.js - API文档生成器，支持ES2015 +和流程注释. (目录 / 文档生成相关)
- awesome-nodejs - documentation - API文档生成器，支持 ES6+ (Uncategorized / Uncategorized)
- awesome-starred - documentationjs/documentation - :book: documentation for modern JavaScript (documentation)
- awesome-documentation - documentation.js - The documentation system for modern JavaScript. (Documentation Types / Code Documentation)
- awesome-nodejs-cn - documentation.js - **star:5791** 支持ES2015+和 flow 注释的 API 文档生成器 ![star > 2000][Awesome] (包 / 文档)
README
The documentation system for modern JavaScript
[](https://circleci.com/gh/documentationjs/documentation/tree/master)
[](http://badge.fury.io/js/documentation)
[](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](http://inch-ci.org/github/documentationjs/documentation)
[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)
- Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) 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
- [HTML output with default template](https://documentation.js.org/html-example/)
- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)
- [JSON](https://documentation.js.org/html-example/index.json)
## Documentation
- [Getting Started](docs/GETTING_STARTED.md): start here
- [Usage](docs/USAGE.md): how to use documentation.js
- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs
- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation
- [Configuring documentation.js](docs/CONFIG.md)
- [FAQ](docs/FAQ.md)
- [Troubleshooting](docs/TROUBLESHOOTING.md)
- [Theming](docs/THEMING.md): tips for theming documentation output in HTML
- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js
## User Guide
Globally install `documentation` using the [npm](https://www.npmjs.com/) package manager:
```sh
$ npm install -g documentation
```
This installs a command called `documentation` in your path, that you can
point at [JSDoc](https://jsdoc.app/about-getting-started.html)-annotated source code to generate
human-readable documentation. First, run `documentation` with the `--help`
option for help:
```sh
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 build index.ts --parse-extension ts -f html -o docs
Commands:
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](CONTRIBUTING.md)
_We have plenty of
[issues](https://github.com/documentationjs/documentation/issues) that we'd
love help with._
- Robust and complete `JSDoc` support, 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.