{"id":13433031,"url":"https://github.com/jsdoc/jsdoc","last_synced_at":"2025-05-12T17:56:00.947Z","repository":{"id":838486,"uuid":"560495","full_name":"jsdoc/jsdoc","owner":"jsdoc","description":"An API documentation generator for JavaScript.","archived":false,"fork":false,"pushed_at":"2025-05-05T11:37:44.000Z","size":26211,"stargazers_count":15210,"open_issues_count":447,"forks_count":1461,"subscribers_count":274,"default_branch":"main","last_synced_at":"2025-05-05T15:17:26.080Z","etag":null,"topics":["api","docs","documentation","javascript","jsdoc"],"latest_commit_sha":null,"homepage":"https://jsdoc.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsdoc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.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":"2010-03-13T09:18:03.000Z","updated_at":"2025-05-05T01:28:10.000Z","dependencies_parsed_at":"2024-01-20T08:24:19.659Z","dependency_job_id":"53b0118a-e070-4061-b3af-c15d26a7aa91","html_url":"https://github.com/jsdoc/jsdoc","commit_stats":{"total_commits":2720,"total_committers":105,"mean_commits":"25.904761904761905","dds":"0.48235294117647054","last_synced_commit":"d8e7ff416fd86dfee9c6ae668b579cf20cf19459"},"previous_names":["jsdoc3/jsdoc"],"tags_count":385,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc%2Fjsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc%2Fjsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc%2Fjsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsdoc%2Fjsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsdoc","download_url":"https://codeload.github.com/jsdoc/jsdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252522172,"owners_count":21761685,"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":["api","docs","documentation","javascript","jsdoc"],"created_at":"2024-07-31T02:01:20.048Z","updated_at":"2025-05-12T17:56:00.894Z","avatar_url":"https://github.com/jsdoc.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Packages","API Docs","Documentation","包","documentation","api","Documentation Types","Utility Libraries"],"sub_categories":["Documentation","文档","Code Documentation"],"readme":"# JSDoc\n\n![Build status](https://github.com/jsdoc/jsdoc/workflows/build/badge.svg)\n\nAn API documentation generator for JavaScript.\n\nWant to contribute to JSDoc? Please read [`CONTRIBUTING.md`](CONTRIBUTING.md).\n\n## Installation and Usage\n\nJSDoc supports stable versions of Node.js 8.15.0 and later. You can install\nJSDoc globally or in your project's `node_modules` folder.\n\nTo install the latest version on npm globally (might require `sudo`;\n[learn how to fix this](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)):\n\n    npm install -g jsdoc\n\nTo install the latest version on npm locally and save it in your package's\n`package.json` file:\n\n    npm install --save-dev jsdoc\n\n**Note**: By default, npm adds your package using the caret operator in front of\nthe version number (for example, `^3.6.3`). We recommend using the tilde\noperator instead (for example, `~3.6.3`), which limits updates to the most\nrecent patch-level version. See\n[this Stack Overflow answer](https://stackoverflow.com/questions/22343224) for\nmore information about the caret and tilde operators.\n\nIf you installed JSDoc locally, the JSDoc command-line tool is available in\n`./node_modules/.bin`. To generate documentation for the file\n`yourJavaScriptFile.js`:\n\n    ./node_modules/.bin/jsdoc yourJavaScriptFile.js\n\nIf you installed JSDoc globally, run the `jsdoc` command:\n\n    jsdoc yourJavaScriptFile.js\n\nBy default, the generated documentation is saved in a directory named `out`. You\ncan use the `--destination` (`-d`) option to specify another directory.\n\nRun `jsdoc --help` for a complete list of command-line options.\n\n## Templates and tools\n\nThe JSDoc community has created templates and other tools to help you generate\nand customize your documentation. Here are a few of them:\n\n### Templates\n\n- [jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)\n- [DocStrap](https://github.com/docstrap/docstrap)\n  ([example](https://docstrap.github.io/docstrap))\n- [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)\n  ([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))\n- [minami](https://github.com/Nijikokun/minami)\n- [docdash](https://github.com/clenemt/docdash)\n  ([example](http://clenemt.github.io/docdash/))\n- [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template)\n  ([example](https://nhnent.github.io/tui.jsdoc-template/latest/))\n- [better-docs](https://github.com/SoftwareBrothers/better-docs)\n  ([example](https://softwarebrothers.github.io/admin-bro-dev/index.html))\n\n### Build tools\n\n- [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)\n- [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3)\n- [JSDoc GitHub Action](https://github.com/andstor/jsdoc-action)\n\n### Other tools\n\n- [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)\n- [Integrating GitBook with\n  JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)\n\n## For more information\n\n- Documentation is available at [jsdoc.app](https://jsdoc.app/).\n- Contribute to the docs at\n  [jsdoc/jsdoc.github.io](https://github.com/jsdoc/jsdoc.github.io).\n- [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/).\n- Ask for help on the\n  [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).\n- Post questions tagged `jsdoc` to\n  [Stack Overflow](http://stackoverflow.com/questions/tagged/jsdoc).\n\n## License\n\nJSDoc is copyright (c) 2011-present Michael Mathews \u003cmicmath@gmail.com\u003e and\nthe [contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors).\n\nJSDoc is free software, licensed under the Apache License, Version 2.0. See the\n[`LICENSE`](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc%2Fjsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsdoc%2Fjsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsdoc%2Fjsdoc/lists"}