This project demonstrates how to provide a arc42 system documentation via Asciidoctor
for an exemplary Spring Boot application.
The app basically consists of a single controller exposing the endpoint http://localhost:8080/hello with a welcome message only,
but also delivers the docu via http://localhost:8080/docs/index.html.
We also deploy the docu to Github Pages.
The documentation is maintained as asciidoc with *.adoc files.
Those files reside in src/main/doc/.
Maven-command mvn package verifycreates static html from asciidoc first (package phase) with the generated HTMLs placed in docs as the result.
The Maven build also copies the files to src/main/resources/static/ (verify phase) in order to be used from the running application.
Github Pages also deploys the static HTML files to https://treboder.github.io/Arc42DocuExample/
For further reference, please consider the following sections:
- Arc42 Templates
- Arc42 Examples
- maven lifecycle
- how-can-i-serve-static-html-from-spring-boot
- maven-copy-files
- creating-a-github-pages-site
- Asciidoctor
- arc42
- Official Apache Maven documentation
- Spring Boot Maven Plugin Reference Guide
- Create an OCI image
- Spring Web
The following guides illustrate how to use some features concretely: