Docgeni
A modern, powerful and out of the box documentation generator for Angular components lib and markdown docs.（现代化的、强大的、开箱即用的 Angular 组件文档生成工具）
Overview
Docgeni is a documentation generation tool that allows users to quickly create and develop documents and components. It provides an independent Angular component preview experience, with features such as component overview, examples, and API.
Features
- Out of the box: Allows users to quickly open the document writing and component development.
- Independent angular component preview experience: Provides a comprehensive preview experience for Angular components, including component overview, examples, and API.
- Extendable markdown syntax: Enables the extension of markdown syntax and direct importing of examples into the document.
- Multi-language support: Supports multiple languages for documentation.
- Multiple modes and themes support: Offers two modes (full and lite) and multiple themes (default and Angular) to customize the UI.
- Powerful customization site ability: Allows customization of HTML, browser support, assets, and more.
- Angular
Angular is a TypeScript-based open-source framework by Google for building dynamic single-page applications and cross-platform mobile apps with MVC architecture and a rich set of features.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
