This project is based on Material for MkDocs. It's a python framework that generates a static html page from markdown files.
Every page can be edited by modifing the content of it's respective markdown (.md) file.
You are redirected to the github edit dialog by using the edit button visible on every page on the top-right.
For contributers that are not within the organization, this means that you can create a Fork and submit your changes/additions using a Pull-Request.
Pages are located withing the docs directory and resolve to the following routes:
docs/index.md -> / (the home page)
docs/something.md -> /something/
docs/something/index.md -> /something/
docs/something/else.md -> /something/else/
docs/something/even/elser.md -> /something/even/elser/
You can run the app locally using only docker & docker-compose using the file docker/docker-compose.yml. This will serve the app in dev mode with hot-reloading & everything.
Alternatively you can run it outside of a container using the following instructions.
- Python 3
- make (recommended)
it is recommended to create a virtual python environment for the project by running make create-env.
Afterwards, to enable to environment in your shell of choice by running:
source env/bin/activate # for linux
. env/Scripts/Activate.ps1 # for windows powershellInstall the dependencies using make install and start a local development server by running make serve.
The hosted website should now be located at http//localhost:8000 and will hot-reload when any changes are made.