This wiki was created to substitute our current wiki at guide/wiki. It uses mkdocs to build and serve the files, this is the source needed to test, edit and compile the wiki.
- Python 2.7 or 3.4 and above
- mkdocs
- mkdocs-material
We recommend reading the mkdocs documentation before doing anything. Click here to a more in-depth explanation on how to use it.
- Clone this repository
cd
inside the repo- run
mkdocs serve
to create a test environment athttp://127.0.0.1:8000/
- if you are satisfied with your changes, run
mkdocs build
to convert the repository into a working website
If you have not installed mkdocs, you have to do it. See how to install.
- Fork the repository
- Translate all the files and edit
mkdocs.yml
with your changes. - Do not send a pull request with translations! We recommend letting us know of your fork, we will build from the source and add it to our wiki.