This is a simple example of how to use documentation as code.
Technologies involved:
- AsciiDoc as format to write the software architecture documentation
- Asciidoctor to generate the representations of the software architecture documentation written in asciidoc
Install Asciidoctor and the Asciidoctor-PDF extension:
Generate the documentation as HTML representation
asciidoctor -b html5 my-example-document.adoc
Generate the documentation as PDF representation
asciidoctor -b pdf -r asciidoctor-pdf my-example-document.adoc