You can find it here:
https://docs.ttt2.neoxult.de
This is the official TTT2 documentation / getting started guide.
Feel free to open up a PR with additional entries or fixes.
The master branch is always auto deployed to our website.
If you want to contribute you can always open up a PR on this repository, we are happy about any contribution.
All the documentation is written in Markdown and can be easily edited even on Github. Just take a look at the docs folder.
If you want to add a new entry, you will have to add the path to the .mkdocs.yml file, right under nav.
To check your changes before submitting a PR or making a commit, you can view a local build of the current documentation as described below.
The mkdocs-material documentation is a good start:
And their overview on all elements and how they look:
You may want to read up on the markdown extensions that are included and how to use them:
Make sure to install mkdocs-material first.
The easiest way would be installing it with pip:
pip install -r requirements.txt
otherwise you will have to look at the other installation methods, provided by mkdocs-material.
Start the preview with the command (when you are currently in the directory of this repository):
mkdocs serve
This project uses:
- Twemoji (Graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/)