Praxis
Asciidoctor
Asciidoc ist eine vereinfachte Auszeichnungssprache, die dazu dient, Texte einfach zu schreiben und optisch ansprechend zu gestalten. Mit dem Asciidoctor kann eine Asciidoc-Datei für die Veröffentlichung in eine HTML- oder PDF-Datei umgewandelt werden.
Asciidoc mit Asciidoctor hat folgende Vorteile:
- Die Syntax ist leicht erlernbar.
- Quelltext ist unverarbeitet gut lesbar.
- Versionen sind vergleichbar.
- Diagramme können eingebettet werden.
- Viele Editoren bieten eine Preview.
Asciidoc ist für technische Dokumentation gut geeignet. Der Text kann mit jedem Editor erstellt werden ist auch unformatiert gut lesbar. Anders als andere Markdown-Dialekte gibt es bei Asciidoc keine Varianten mit unterschiedlicher Syntax oder besonderen Fähigkeiten. Es gibt nur eine einzige Spezifikation für Asciidoc.
Durch Erweiterungen von Asciidoctor können im Text verschiedene Arten von Diagrammen eingebettet werden. Mit PlantUML stehen praktisch alle Diagrammarten der UML, Gantt-Diagramme, Mindmaps oder Wireframes zur Verfügung.