README.zh-CN.md

Docgeni

一个现代化，强大且开箱即用的 Angular 组件文档生成器，用于 Angular 组件库和普通的 Markdown 文档生成。

English | 中文文档

✨ 特性

• 📦 开箱即用，让你快速开启文档编写和组件开发
• 🏡 独立的 Angular 组件预览体验，包含：组件概览，示例，API
• 📋 对 Markdown 语法进行扩展，在文档中直接导入 Example
• 💻 多语言支持
• 🎨 两种模式(full和lite)以及多种风格(default和angular)支持
• 🚀 强大的自定义能力

📖 文档

开始使用 Docgeni，可以去官网学习基础知识并搜索高级功能。

• 介绍
• 快速开始
• 路由导航和菜单
• 配置

高级

• 自定义站点
• 多语言

谁在使用 Docgeni?

PingCode

Worktile

ngx-planet

☘️ 徽章

展示使用 docgeni 的徽章，可以添加如下的语法到 README 中：

[![docgeni](https://img.shields.io/badge/docs%20by-docgeni-348fe4)](https://github.com/docgeni/docgeni)

🎉 版本

@docgeni/*	@angular/*	Description
<0.5.x	>=9.0 <=13.0	-
>0.5.x	>=10.0 <=13.0	-
1.0.x	>=10.0 <=13.0	-
1.1.x	>=10.0 <=13.0	-
2.0.x	>=12.0 <=14.0	-
2.1.x	>=14.0 <=15.0	-
2.2.x	>=16.0 <=16.0	-

💻 开发

yarn   // 安装所有依赖

yarn start              // 启动站点，监控文档和组件文件夹的修改重新生成站点
yarn build              // 构建所有的包
yarn build-deps         // 构建所有底层依赖的包
yarn build:docs         // 构建文档站点

yarn test               // 执行单元测试

💼 包

Package	Version	Links
@docgeni/cli
@docgeni/core
@docgeni/toolkit
@docgeni/template

许可证

MIT LICENSE