This is a simple configuration for creating documentation with Antora Docs.
It includes:
-
Dockerfile
-
Kroki (Plant UML and others)
-
Search
A Makefile and a Taskfile.yml can be used to build the docs. These are the same so you can choose which is best for your use case.
Makefile
-
make install: Builds the Dockerfile. -
make build: Compiles Antora Docs. -
make sh: Opens the Container. -
make server: Starts a new server for the html version. (requires python3).
Taskfile.yml
-
task install: Builds the Dockerfile. -
task build: Compiles Antora Docs. -
task sh: Opens the Container. -
task server: Starts a new server for the html version. (requires python3).
-
antora/: Contains the main antora docs configuration files and documentation. -
docs/: The build command will generate a docs directory so it can be used in Github pages.
This separation is important so the developer can use this template and add it
to a ongoing project easily or start a new one using the file structure as a base.
The important thing is storing antora-playbook.yml at the same level as the .git directory.
Created with ❤️ by Camilo Castro and contributors[1]. for Ninjas.cl[2].
This document is licensed with Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International[3]
Made with ♥ by Ninjas.cl .
-
Original Template: Asciidoc Book Template
