This repo is the source for the official PiVPN Documentation.
PiVPN Documentation is powered by MKDocs-Material,
To add a new link on the navigation panel you need to edit the
mkdocs.yml file in the root of the repo. There is a guide for building the navbar at mkdocs wiki
To add a new document
When working on this repo, it is advised that you review your changes locally before committing them. The
mkdocs serve command can be used to live preview your changes (as you type) on your local machine.
git clone https://github.com/YOUR-USERNAME/docs
git commit -a, make sure you add a nice message to your commit
git push origin master
Once changes are merged to master branch, CI Pipeline will run and take care of everything. It may take up to 24h until changes are visible on live documentation website.