{"id":13394736,"url":"https://github.com/documentationjs/documentation","last_synced_at":"2025-05-13T15:04:33.962Z","repository":{"id":28421921,"uuid":"31936600","full_name":"documentationjs/documentation","owner":"documentationjs","description":":book: documentation for modern JavaScript","archived":false,"fork":false,"pushed_at":"2025-04-15T18:50:26.000Z","size":7704,"stargazers_count":5790,"open_issues_count":210,"forks_count":485,"subscribers_count":55,"default_branch":"master","last_synced_at":"2025-05-05T22:41:46.319Z","etag":null,"topics":["babel","documentation","documentation-tool","javascript","jsdoc"],"latest_commit_sha":null,"homepage":"http://documentation.js.org/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"inferjay/AndroidDevTools","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/documentationjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-03-10T03:34:09.000Z","updated_at":"2025-05-02T17:00:22.000Z","dependencies_parsed_at":"2025-04-23T17:15:40.296Z","dependency_job_id":"c6ad2902-5a2d-4b47-af6d-ad723a70833b","html_url":"https://github.com/documentationjs/documentation","commit_stats":{"total_commits":1284,"total_committers":132,"mean_commits":9.727272727272727,"dds":"0.44548286604361376","last_synced_commit":"b4088dbf99523333a45cb88cc93f698cc8699906"},"previous_names":[],"tags_count":116,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/documentationjs","download_url":"https://codeload.github.com/documentationjs/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253210723,"owners_count":21871872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","documentation","documentation-tool","javascript","jsdoc"],"created_at":"2024-07-30T17:01:29.916Z","updated_at":"2025-05-13T15:04:33.890Z","avatar_url":"https://github.com/documentationjs.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./.github/documentation-js-logo.png\" width=\"650\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  The documentation system for modern JavaScript\n\u003c/p\u003e\n\n[![Circle CI](https://circleci.com/gh/documentationjs/documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/documentation/tree/master)\n[![npm version](https://badge.fury.io/js/documentation.svg)](http://badge.fury.io/js/documentation)\n[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/documentationjs/documentation?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master\u0026style=flat-square)](http://inch-ci.org/github/documentationjs/documentation)\n\n[:date: Current maintenance status](https://github.com/documentationjs/documentation/wiki/Current-maintenance-status)\n\n- Supports modern JavaScript: ES5, ES2017, JSX, Vue and [Flow](https://flow.org/) type annotations.\n- Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.\n- Integrates with GitHub to link directly from documentation to the code it refers to.\n- Customizable output: HTML, JSON, Markdown, and more\n\n## Examples\n\n- [HTML output with default template](https://documentation.js.org/html-example/)\n- [Markdown](https://github.com/documentationjs/documentation/blob/master/docs/NODE_API.md)\n- [JSON](https://documentation.js.org/html-example/index.json)\n\n## Documentation\n\n- [Getting Started](docs/GETTING_STARTED.md): start here\n- [Usage](docs/USAGE.md): how to use documentation.js\n- [Recipes](docs/RECIPES.md): tricks for writing effective JSDoc docs\n- [Node API](docs/NODE_API.md): documentation.js's self-generated documentation\n- [Configuring documentation.js](docs/CONFIG.md)\n- [FAQ](docs/FAQ.md)\n- [Troubleshooting](docs/TROUBLESHOOTING.md)\n- [Theming](docs/THEMING.md): tips for theming documentation output in HTML\n- [See also](https://github.com/documentationjs/documentation/wiki/See-also): a list of projects similar to documentation.js\n\n## User Guide\n\nGlobally install `documentation` using the [npm](https://www.npmjs.com/) package manager:\n\n```sh\n$ npm install -g documentation\n```\n\nThis installs a command called `documentation` in your path, that you can\npoint at [JSDoc](https://jsdoc.app/about-getting-started.html)-annotated source code to generate\nhuman-readable documentation. First, run `documentation` with the `--help`\noption for help:\n\n```sh\nUsage:\n\n# generate markdown docs for index.js and files it references\ndocumentation build index.js -f md\n\n# generate html docs for all files in src, and include links to source files in github\ndocumentation build src/** -f html --github -o docs\n\n# document index.js, ignoring any files it requires or imports\ndocumentation build index.js -f md --shallow\n\n# validate JSDoc syntax in util.js\ndocumentation lint util.js\n\n# update the API section of README.md with docs from index.js\ndocumentation readme index.js --section=API\n\n# build docs for all values exported by index.js\ndocumentation build --document-exported index.js\n\n# build html docs for a TypeScript project\ndocumentation build index.ts --parse-extension ts -f html -o docs\n\nCommands:\n  build [input..]   build documentation\n  lint [input..]    check for common style and uniformity mistakes\n  readme [input..]  inject documentation into your README.md\n\nOptions:\n  --version  Show version number                                       [boolean]\n  --help     Show help                                                 [boolean]\n```\n\n## [Contributing](CONTRIBUTING.md)\n\n_We have plenty of\n[issues](https://github.com/documentationjs/documentation/issues) that we'd\nlove help with._\n\n- Robust and complete `JSDoc` support, including typedefs.\n- Strong support for HTML and Markdown output\n- Documentation coverage, statistics, and validation\n\ndocumentation is an OPEN Open Source Project. This means that:\n\nIndividuals making significant and valuable contributions are given\ncommit-access to the project to contribute as they see fit. This\nproject is more like an open wiki than a standard guarded open source project.\n","funding_links":[],"categories":["JavaScript","Packages","Repository","包","Tools","Built on rehype","Documentation","目录","Uncategorized","babel","documentation","Documentation Types","\u003ca name=\"JavaScript\"\u003e\u003c/a\u003eJavaScript","Built on remark"],"sub_categories":["Documentation","文档相关","文档生成相关","Uncategorized","文档","Code Documentation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocumentationjs%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fdocumentation/lists"}