Docgeni
A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.
English | 中文文档
- 📦 Out of the box, let you quickly open the document writing and component development
- 🏡 Independent angular component preview experience, including: component overview, examples, and API
- 📋 Extend the markdown syntax and import examples directly into the document
- 💻 Multi-language support
- 🎨 Two modes(
full
andlite
) and multiple themes(default
andangular
) support - 🚀 Powerful customization site ability (HTML, Browser support, Assets ...)
Get started with Docgeni, learn the fundamentals and explore advanced topics on our documentation website.
PingCode |
Worktile |
ngx-planet |
Show the world you're using docgeni? Add a README badge to show it via:
[![docgeni](https://img.shields.io/badge/docs%20by-docgeni-348fe4)](https://github.com/docgeni/docgeni)
yarn // install dependencies for all packages
yarn start // build docs, watch docs change and start site project
yarn build // build all packages
yarn build-deps // build all deps packages
yarn build:docs // build docs & site project
yarn test // run test cases
Package | Version | Links |
---|---|---|
@docgeni/cli |
||
@docgeni/core |
||
@docgeni/toolkit |
||
@docgeni/template |