docgeni

Docgeni

Ein moderner, mächtiger und aus dem Box -Dokumentationsgenerator für Winkelkomponenten Lib und Markdown -Dokumente.

Englisch | 中文文档

Merkmale

• ? Lassen Sie Sie nicht über die Schachtel heraus das Schreiben und die Komponentenentwicklung des Dokuments öffnen
• ? Vorschauerfahrung für unabhängige Winkelkomponente, einschließlich: Komponentenübersicht, Beispiele und API
• ? Erweitern Sie die Markdown -Syntax und importieren Sie Beispiele direkt in das Dokument
• Multisprachiger Unterstützung
• ? Zwei Modi ( full und lite ) und mehrere Themen ( default und angular )
• Leistungsstarke Fähigkeit zur Anpassungsseite (HTML, Browser -Unterstützung, Vermögenswerte ...)

Dokumentation

Beginnen Sie mit Docgeni, lernen Sie die Grundlagen und erkunden Sie fortgeschrittene Themen auf unserer Dokumentations -Website.

• Einführen
• Erste Schritte
• Route & NAV & Menü
• Konfiguration

Fortschrittlich

• Site anpassen
• Multisprachiger

Wer benutzt DocGeni?

Pingcode

Arbeitstil

NGX-Planet

☘️ Abzeichen

Zeigen Sie der Welt, die Sie docgeni verwenden? Fügen Sie ein Readme -Abzeichen hinzu, um es zu zeigen über:

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

? Versionen

@docgeni/*	@Angular/*	Beschreibung
<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	- -

Entwicklung

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

Pakete

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

LIZENZ

MIT -Lizenz