Skip to content

DocumentationBuild

DavidFreely edited this page Nov 6, 2025 · 7 revisions

GitHub Wiki

GitHub Wiki transforms textfiles to html itself, no need to care about that.

Static Side Builder (SSG) - MkDocs ('deprecated')

At the moment MkDocs ist startet manually to build the files (DocumentationFileFormat).

Parts

GitHub Actions

Can be used to automate the build-process of the HTML-documentation-files whenever a commit to the main branch is made. So the Docs can always stay up to date.

GitHub Action Documentation Build Config: [link]

MkDocs

A config file "/DocsSource/mkdocs.yml" needs to be created. Parameters for the build-process and output can be written in it. Mkdocs, when run, will basically then read the content-files from "/DocsSource/Content/" ('docs_dir') and give out the HTML-files into "/docs/" ('site_dir').

Clone this wiki locally