Home - Docgeni

Out of the box

Automatically generate navigation and menus according to the directory structure, and help developers get started at zero cost through command-line tools, so that you can quickly start writing document and development component

Born for Angular Component Development

Independent angular component preview experience that contains component overview, examples, APIs and rich markdown extensions make it easier to write documents and support multiple libraries at one site

Two modes and multiple styles support

Full and Lite modes are supported to meet different needs. At the same time, default and angular styles are supported to allow users to choose their own themes

Powerful Customization

It provides publicDir to realize features such as custom HTML, resources and styles, and supports AppModule metadata and fully customized site

Automatic Generation of Component API

Automatically generate component APIs based on typescript type definitions and comments, and maintain the consistency of code and documents

Multilingual

Support flexible multilingual configuration

Getting Started

switch to an existing project, execute the following command:

bash$ npx @docgeni/cli init
# or 
$ docgeni init 
# or
$ ng add @docgeni/cli

run npm run start:docs command to start site，open http://127.0.0.1:4600 visit it by browser.

Click Getting Started see more.

Contributing

Welcome to contribute together Docgeni: https://github.com/docgeni/docgeni