🕮 DocumentationTemplate

This project aims to provide a lightweight preconfiguration for software documentation.

Intentionally barebone structure and docker/asciidoctor setup. General structure for Austrian HTL students is provided, other than that you will have to configure all required dependencies, packages and themes yourself.

Exection

exec.{bat,bash}

# PDF - Quickstart
generates the pdf file instantly and destroys the container afterwards

pro-exec.{bat,bash}

# Custom Usage
creates the docker container and connects you to the container internal prompt

🪟 Windows

usage per 🖱️ DoubleClick on the bat file

🐧 Linux (Unix)

# bash [filename]

Requirements

• ✓ Docker installed

• ✓ Diploma project

Tipps

For perfect usage you will have to include a gitmodule / reference to your actual diploma project

Recommended Dependencies :

• asciidoctor-diagram

Examples :

• 2023 - 3D_printing_web_interface