Docs-as-Code project demonstrates the use of Asciidoc to generate software documentation. Combining models from the following sources:
Generation of diagrams is supported using PlantUML.
- AsciidoctorJ is the official library for running Asciidoctor on the JVM. Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of a parsed AsciiDoc document from Java and other JVM languages.
-
asciidoctor-gradle-plugin
-
asciidoctorj-diagram
Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.
The extensions supports:
-
asciidoctorj-pdf
-
gradle
-
Graphviz
- Java installed
- Graphviz installed (needed to generate diagrams)
Execute the documentation generation by:
./gradlew asciidoctor
The generated documentation can be found at:
/build/asciidoc/index.html
(HTML website)/build/asciidoc/index.pdf
(PDF document)
This project is licensed under the MIT License - see the LICENSE file for details
- The documentation template is inspired by the ARC42 model/C4-Model and Architecture Decision Records.