Skip to content

raifdmueller/docs-and-diagrams-as-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docs-as-Code und Diagrams-as-Code Übungen mit docToolchain

Dieses Repository enthält Übungen für Docs-as-Code und Diagrams-as-Code mit docToolchain und AsciiDoc.

Struktur

  • /src/docs - Hauptdokumentation

  • /src/docs/exercises - Praktische Übungen

  • /src/docs/arc42 - Architektur-Dokumentation nach arc42

  • /src/docs/diagrams - Diagramme (PlantUML, Mermaid, etc.)

  • /src/docs/config - Konfigurationsdateien

Setup

  1. docToolchain installieren: bash wget https://github.com/docToolchain/docToolchain/releases/download/v2.0.0/docToolchain-2.0.0.zip unzip docToolchain-2.0.0.zip ./docToolchain

  2. Projekt initialisieren: bash ./docToolchain init

  3. Dokumentation generieren: bash ./docToolchain generateHTML

Übungen

Siehe /src/docs/exercises/README.adoc für eine Übersicht aller Übungen.

About

Übungsrepository für Docs-as-Code und Diagrams-as-Code mit AsciiDoc

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors