Template for technical documentation of libraries, subsystems and systems with AsciiDoc.
This is not intended to be a template for end user documentation of a system.
Providing and maintaining documentation for developers, agile testers, and DevOps engineers side by side with the source-code reduces the maintenance effort. The motivation behind this template is to provide an easy way to include AsciiDoc based documentation in a GitHub repository.
The topics of the skeleton are parts which are often integrated in repositories to cope with the different needs of developers and DevOps engineers.
-
Getting Started (only page)
-
Reference / API Documentation (only page)
-
Examples Documentation (only page)
-
Architecture Documentation - The Arc42 Template (complete - with help)
-
Development Environment Setup (only page)
-
Continuos Integration / Continuos Deployment Setup (only page)
The documentation is written in the AsciiDoc language and processed by a GitHub action which stores the resulting HTML pages in the gh-pages branch which is published as github pages.
The Repository contains a Visual Studio Code configuration, so that external images and Diagrams are rendered in the asciidoc preview extension.
The AsciiDoc-Diagramming extension is enabled in the github action and the vscode editing preview. Among others it allows to integrate PlantUML diagrams.
-
Asciidoctor Homepage
https://asciidoctor.org/ -
Asciidoctor Repositories
https://github.com/asciidoctor -
Asciidoc Writers Guide
https://asciidoctor.org/docs/asciidoc-writers-guide/
-
Diagramming extension for asciidoc
https://github.com/asciidoctor/asciidoctor-diagram -
Asciidoctor Skins
https://github.com/darshandsoni/asciidoctor-skins
-
Plantuml Homepage
https://plantuml.com -
Skinparam
https://plantuml.com/en/skinparam
ARC42 is a architecture documentation template developed by Gernot Starke and Peter Hruschka.
-
Arc42 Homepage
https://arc42.org/ -
Arc42 License
https://arc42.org/license
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License CC BY-SA 4.0
