{"repo":"documentationjs/documentation","free":true,"listed":false,"github":"https://github.com/documentationjs/documentation","clone":"git clone https://github.com/documentationjs/documentation.git","description":":book: documentation for modern JavaScript","language":"JavaScript","stars":5800,"topics":["documentation-tool","documentation","jsdoc","javascript","babel"],"license":null,"category":"docs-static-sites","readme_excerpt":"The documentation system for modern JavaScript :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 - HTML output with default template - Markdown - JSON 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: 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: Contributing We have plenty of 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 ","default_branch":null,"files":null,"tree":[],"storefront":"/r/documentationjs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/documentationjs/documentation/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}