Welkom bij de documentatie van GWTONN

Voor algemene informatie over Ge Wit't Oit Noit Nie kijk op onze website.

Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        year/
            2025/ # All about the year 2025 setup
        gwtonn_library/ # Specific information about the general GWTONN Library support

Prerequisites

De volgende applicaties zijn nodig:

• VSCode: 1.98.2 of hoger
• Python
• mkdocs: >= 1.6.1

Verder worden de volgende extenties aangeraden voor VSCode:

GitHub Suport

• GitHub Pull Requests

Markdown support

• Markdown All in One
• Markdown Table
• markdownlint

YAML Support

• YAML Language Support by Red Hat

Basis MKDocs gebruik

Lokaal bekijken

Voor het testen van de site gebruik de volgende commando:

.\venv\Scripts\activate.ps1
mkdocs serve

Documentatie deployen

Om de documentatie te deployen, kan je handmatig een deploy starten:

.\venv\Scripts\activate.ps1
mkdocs gh-deploy

Dit script al dan een statische site maken en beschikbaar maken op de gh-pages branch.

Waarschuwing

Als er niet-getrackte bestanden of niet-gecommit werk zijn in de lokale repository waar mkdocs gh-deploy wordt uitgevoerd, zullen deze worden opgenomen in de pagina's die worden gedeployed.

Opmerking

Dit is niet noodzakelijk. Tijdens het mergen van een pull request gebeurt het automatisch.

Prepareren van het systeem

Installeren van python virtual environment

Voor het gebruik van mkdocs kan het best gebruik gemaakt worden van een virtuele python omgeving. Deze kan je als volgt maken:

python -m venv venv

Op een windows machine kan je deze activeren met:

.\venv\Scripts\activate.ps1

Op MaOS or Linux kan je deze activeren met:

source ./venv/bin/activate

Installatie mkdocs

Voor het gebruik van mkdocs kan gebruikt worden van een virtuele python omgeving. Zie voor het opzetten van de omgeving mkdocs website

.\venv\Scripts\activate.ps1
pip install -r requirements.txt