{"id":13806986,"url":"https://github.com/docgeni/docgeni","last_synced_at":"2025-05-15T16:05:13.009Z","repository":{"id":38425462,"uuid":"248404640","full_name":"docgeni/docgeni","owner":"docgeni","description":"📖 A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.（现代化的、强大的、开箱即用的 Angular 组件文档生成工具）","archived":false,"fork":false,"pushed_at":"2025-05-01T20:52:28.000Z","size":12639,"stargazers_count":199,"open_issues_count":7,"forks_count":25,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-05T10:08:14.889Z","etag":null,"topics":["angular","components","docgeni","docs-generate","docs-generator","documention","library"],"latest_commit_sha":null,"homepage":"https://docgeni.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docgeni.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2020-03-19T03:46:07.000Z","updated_at":"2025-03-26T03:20:45.000Z","dependencies_parsed_at":"2023-02-18T18:15:34.110Z","dependency_job_id":"fd377e95-22c6-40f4-92f7-9d5b655bbc37","html_url":"https://github.com/docgeni/docgeni","commit_stats":{"total_commits":816,"total_committers":17,"mean_commits":48.0,"dds":"0.35539215686274506","last_synced_commit":"73630f3339a1c9ed296a627ff0a41bd38ca3355c"},"previous_names":[],"tags_count":143,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docgeni%2Fdocgeni","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docgeni%2Fdocgeni/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docgeni%2Fdocgeni/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docgeni%2Fdocgeni/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docgeni","download_url":"https://codeload.github.com/docgeni/docgeni/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374410,"owners_count":22060610,"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":["angular","components","docgeni","docs-generate","docs-generator","documention","library"],"created_at":"2024-08-04T01:01:18.995Z","updated_at":"2025-05-15T16:05:12.942Z","avatar_url":"https://github.com/docgeni.png","language":"TypeScript","readme":"\u003cp align=\"center\" style=\"margin-bottom: -20px\"\u003e\n  \u003ca href=\"https://docgeni.org\" target=\"_blank\"\u003e\u003cimg width=\"80px\" height=\"80px\" src=\"https://github.com/docgeni/docgeni/blob/master/.docgeni/public/assets/images/logo.png?raw=true\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eDocgeni\u003c/strong\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\nA modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.\n\u003c/p\u003e\n\n[![docgeni](https://img.shields.io/badge/docs%20by-docgeni-348fe4)](https://github.com/docgeni/docgeni)\n[![CircleCI](https://circleci.com/gh/docgeni/docgeni.svg?style=shield)](https://circleci.com/gh/docgeni/docgeni)\n[![Coverage Status][coveralls-image]][coveralls-url]\n[![npm (scoped)](https://img.shields.io/npm/v/@docgeni/cli?style=flat)](https://www.npmjs.com/package/@docgeni/cli)\n[![npm](https://img.shields.io/npm/dm/@docgeni/cli)](https://www.npmjs.com/package/@docgeni/cli)\n[![npm](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\n)](https://github.com/prettier/prettier)\n\n\n[coveralls-image]: https://coveralls.io/repos/github/docgeni/docgeni/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/github/docgeni/docgeni?branch=master\n\nEnglish | [中文文档](https://github.com/docgeni/docgeni/blob/master/README.zh-CN.md)\n\n## ✨ Features\n- 📦 Out of the box, let you quickly open the document writing and component development\n- 🏡 Independent angular component preview experience, including: component overview, examples, and API\n- 📋 Extend the markdown syntax and import examples directly into the document\n- 💻 Multi-language support\n- 🎨 Two modes(`full` and `lite`) and multiple themes(`default` and `angular`)  support\n- 🚀 Powerful customization site ability (HTML, Browser support, Assets ...)\n\n## 📖 Documentation\nGet started with Docgeni, learn the fundamentals and explore advanced topics on our documentation website.\n- [Introduce](https://docgeni.org/guides/intro)\n- [Getting Started](https://docgeni.org/guides/getting-started)\n- [Route \u0026 Nav \u0026 Menu](https://docgeni.org/guides/route-nav-menu)\n- [Configuration](https://docgeni.org/guides/configuration)\n\n### Advanced\n- [Customize Site](https://docgeni.org/guides/advance/customize)\n- [Multi-language](https://docgeni.org/guides/advance/locales)\n\n## Who are using Docgeni?\n\n\u003ctable style=\"margin-top: 20px;\"\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"160\" align=\"center\" style=\"padding: 20px\"\u003e\n      \u003ca target=\"_blank\" href=\"https://pingcode.com?utm_source=github-docgeni\"\u003e\n        \u003cimg src=\"https://cdn.worktile.com/static/portal/assets/images/logos/square.png\" height=\"40\"/\u003e\n        \u003cbr /\u003e\n        \u003cstrong\u003ePingCode\u003c/strong\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"160\" align=\"center\" style=\"padding: 20px\"\u003e\n       \u003ca target=\"_blank\" href=\"https://worktile.com?utm_source=github-docgeni\"\u003e\n        \u003cimg src=\"https://cdn.worktile.com/static/charm/assets/images/team_logo.png\" height=\"40\"/\u003e\n        \u003cbr /\u003e\n        \u003cstrong\u003eWorktile\u003c/strong\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd width=\"160\" align=\"center\"  style=\"padding: 20px\"\u003e\n      \u003ca target=\"_blank\" href=\"https://github.com/worktile/ngx-planet\"\u003e\n        \u003cimg src=\"https://cdn.worktile.com/open-sources/ngx-tethys/logos/tethys.png\" height=\"40\" /\u003e\n        \u003cbr /\u003e\n        \u003cstrong\u003engx-planet\u003c/strong\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e \n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## ☘️ Badge\nShow the world you're using docgeni?\nAdd a README badge to show it via: \n\n```\n[![docgeni](https://img.shields.io/badge/docs%20by-docgeni-348fe4)](https://github.com/docgeni/docgeni)\n```\n\n[![docgeni](https://img.shields.io/badge/docs%20by-docgeni-348fe4)](https://github.com/docgeni/docgeni)\n\n## 🎉 Versions\n\n@docgeni/*| @angular/*| Description\n---| --- | --- \n\u003c0.5.x|\u003e=9.0 \u003c=13.0 | -\n\\\u003e0.5.x|\u003e=10.0 \u003c=13.0 | -\n1.0.x|\u003e=10.0 \u003c=13.0 | -\n1.1.x|\u003e=10.0 \u003c=13.0 | -\n2.0.x|\u003e=12.0 \u003c=14.0 | -\n2.1.x|\u003e=15.0 \u003c16.0 | -\n2.2.x|\u003e=16.0 \u003c17.0 | -\n2.3.0|\u003e=17.0 \u003c18.0 | -\n2.4.0|\u003e=18.0 \u003c19.0 | -\n2.5.0|\u003e=19.0 \u003c20.0 | -\n\n\n## 💻 Development\n\n```bash\nyarn   // install dependencies for all packages\n```\n\n```bash\nyarn start              // build docs, watch docs change and start site project\nyarn build              // build all packages\nyarn build-deps         // build all deps packages\nyarn build:docs         // build docs \u0026 site project\n\nyarn test               // run test cases\n```\n\n## 💼 Packages\n\nPackage| Version| Links\n---| --- | --- \n[`@docgeni/cli`](https://npmjs.com/package/@docgeni/cli) | [![latest](https://img.shields.io/npm/v/%40docgeni%2Fcli/latest.svg)](https://npmjs.com/package/@docgeni/cli) | [![README](https://img.shields.io/badge/README--green.svg)](/packages/cli/README.md) \n[`@docgeni/core`](https://npmjs.com/package/@docgeni/core) | [![latest](https://img.shields.io/npm/v/%40docgeni%2Fcore/latest.svg)](https://npmjs.com/package/@docgeni/core) | [![README](https://img.shields.io/badge/README--green.svg)](/packages/core/README.md) \n[`@docgeni/toolkit`](https://npmjs.com/package/@docgeni/toolkit) | [![latest](https://img.shields.io/npm/v/%40docgeni%2Ftoolkit/latest.svg)](https://npmjs.com/package/@docgeni/toolkit)  | [![README](https://img.shields.io/badge/README--green.svg)](/packages/toolkit/README.md) \n[`@docgeni/template`](https://npmjs.com/package/@docgeni/template) | [![latest](https://img.shields.io/npm/v/%40docgeni%2Ftemplate/latest.svg)](https://npmjs.com/package/@docgeni/template)  | [![README](https://img.shields.io/badge/README--green.svg)](/packages/template/README.md) \n\n## LICENSE\n\n[MIT LICENSE](https://github.com/docgeni/docgeni/blob/master/LICENSE)\n","funding_links":[],"categories":["Development Utilities"],"sub_categories":["Documentation Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocgeni%2Fdocgeni","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocgeni%2Fdocgeni","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocgeni%2Fdocgeni/lists"}