Antora & AsciiDoc

Publication

All content is published to https://dev.timafe.net/angkor-docs

Release

Guide supports only one version: main. Everything on main branch will be published. The publication process is triggered by this project’s github Action.

Antora Site Generator

This module uses [Antora](https://docs.antora.org/antora/2.3/) - "The Static Site Generator for Tech Writers" TIP: Use Admonitions to draw attention to content with a special label or icon

Diagram Support

PlantUML Diagrams in asciidoc

plantuml.com component diagram but real-world-plantuml.com provides a better overview

Simple Angkor Architecture Overview
Figure 1. Simple Angkor Architecture Overview

PlanttUML in Github README.md

Support UML diagrams in markdown with plantuml syntax

https://yuml.me/diagram/scruffy/class/[Igel]-%3E[Hase]

or

![alternative text](https://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.github.com/plantuml/plantuml-server/master/src/main/webapp/resource/test2diagrams.txt