docgeni

Docgeni

Un générateur de documentation moderne, puissant et hors de la boîte pour les composants angulaires Lib et Markdown Docs.

Anglais | 中文文档

Caractéristiques

• ? Hors de la boîte, laissez-vous ouvrir rapidement la rédaction du document et le développement des composants
• ? Expérience prévisuale indépendante des composants angulaires, y compris: aperçu des composants, exemples et API
• ? Étendre la syntaxe de Markdown et importer des exemples directement dans le document
• Support multi-langues
• ? Deux modes ( full and lite ) et plusieurs thèmes ( default et angular )
• Capacité de site de personnalisation puissante (HTML, support du navigateur, actifs ...)

Documentation

Commencez avec Docgeni, apprenez les principes fondamentaux et explorez des sujets avancés sur notre site Web de documentation.

• Introduire
• Commencer
• Route et navigation et menu
• Configuration

Avancé

• Personnaliser le site
• Multi-langus

Qui utilise Docgeni?

Ping-ping

De travail

ngx-planet

☘️ Badge

Montrez le monde que vous utilisez Docgeni? Ajoutez un badge Readme pour le montrer via:

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

? Versions

@ docgeni / *	@angulaire/*	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	> = 15,0 <16,0	-
2.2.x	> = 16,0 <17.0	-
2.3.0	> = 17,0 <18.0	-
2.4.0	> = 18,0 <19,0	-

Développement

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

Packages

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

LICENCE

Licence MIT