We are using mkdocs to manage our documentation.
We're really happy if you want to contribute to make the documentation better! This is done by creating a pull request.
- Download, install dependencies
Make sure you have Python3 installed.
git clone https://github.com/waterlinked/waterlinked.github.io
cd waterlinked.github.io
python -m venv venv
source venv/bin/activate (Linux)
venv\Scripts\activate.bat (Windows)
pip install -r requirements.txt
mkdocs serve
-
Make changes using your favorite editor
-
Test them
- Fire up your browser and go to localhost:8000
After the changes have been tested and they work, push the changes to the master branch and Github will build the website and publish it on https://docs.waterlinked.com.