mpas/docs-as-code

Example project to demonstrate the use of Asciidoc to generate software documentation. Using Arc42,C4,ADR and integration with PlantUML.

MIT

Docs-as-Code

Example project to demonstrate the use of Asciidoc to generate software documentation. Combining models from the following sources:

Arc42
C4-model
Architecture Decision Records

Generation of diagrams is supported using PlantUML.

Please feel free to adjust the template and have fun generating you own documentation.

Getting Started

Prerequisites

Java installed
Graphviz installed (needed to generate diagrams)

Running

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)

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

The documentation template is inspired by the ARC42 model/C4-Model and Architecture Decision Records.