badge_2024

The general repository for the Fri3dcamp 2024 badge. Access the documentation here: https://fri3dcamp.github.io/badge_2024/

Documentation will be written using the mkdocs system as a reference. You can find them in the docs folder.

Initially everything will be written in English, Dutch translation will be added later.

Something missing? Please open an issue or a pull request.

View docs locally

To see if your changes are correctly formatted, you can view the documentation locally with Python.

It is advised to run it inside a virtual environment such as venv or virtualenv.

For venv you can create a virtual environment with:

python -m venv .venv

Then activate the virtual environment with:

source .venv/bin/activate

For Python 3.6 and higher, you can install mkdocs and the material theme with the following command:

pip install -r requirements.txt

Then you can start the local server with:

mkdocs serve

The documentation then be available at http://127.0.0.1:8000/badge_2024/