Asciidoc(tor)
«Documentation as Code» mit Asciidoc(tor)
Asciidoc ist eine vereinfachte Auszeichnungssprache, die dazu dient, Texte einfach zu schreiben und optisch ansprechend zu gestalten.
- Die Syntax ist leicht erlernbar.
- Der Quelltext ist unverarbeitet gut lesbar.
- Versionen sind vergleichbar.
- Diagramme können eingebettet werden.
- Viele Editoren bieten eine Preview.
Asciidoc ist für jede Art technischer Dokumentation sehr 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.
Asciidoctor ist ein schneller Textprozessor zum Parsen von Asciidoc. Das Programm ist in der
Programmiersprache Ruby geschrieben. Mit dem Asciidoctor
kann eine Asciidoc-Datei für die Veröffentlichung in eine HTML
- oder PDF
-Datei umgewandelt werden.