Docgeni

开箱即用的 Angular 组件文档生成工具

开箱即用

根据目录结构自动生成导航和菜单，同时通过命令行工具帮助开发者零成本上手，让你快速开始文档编写和组件开发

为 Angular 组件开发而生

独立的 Angular 组件预览体验，组件概览，示例，API，丰富的 Markdown 扩展，使文档编写起来更简单，支持同时存在多个类库

两种模式和多种风格支持

支持 full 和 lite 两种模式满足不同的需求，同时支持默认和 Angular 风格，让用户选择适合自己的主题

强大的自定义能力

提供了 publicDir 实现自定义 HTML，资源，样式等功能，同时还支持定义根模块元数据以及完全自定义的站点

组件 API 自动生成

基于 TypeScript 类型定义和注释自动生成组件 API，维护代码和文档始终如一

多语言支持

支持灵活的多语言配置

快速上手

切换到已有的项目中，执行如下命令：

bash$ npx @docgeni/cli init
# 或者 
$ docgeni init 
# 或者
$ ng add @docgeni/cli

初始化后，使用npm run start:docs启动文档站点，浏览器打开http://127.0.0.1:4600 即可访问。

点击快速上手了解更多。