Example project to demonstrate the use of Asciidoc to generate software documentation. Combining models from the following sources:
Generation of diagrams is supported using PlantUML.
Please feel free to adjust the template and have fun generating you own documentation.
- 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 Creative Commons Attribution-ShareAlike 4.0 International License - see the LICENSE file for details
- The documentation template is inspired by the ARC42 model/C4-Model and Architecture Decision Records.