This is the source for the Tildagon Badge Documentation. Contributions are welcome!

Run these commands to set up a Python virtual environment and install the required packages for the project in the project folder:

pip install pipenv
pipenv install

You only need to run this command once. To activate the virtual environment, run:

pipenv shell

If you open a new terminal window, navigate back to the project folder and activate the virtual environment again.

To serve the docs locally on your machine, run the following command:

mkdocs serve

To generate the full HTML version of the docs run:

make build-prod

You can serve the resulting docs with:

python3 -m http.server 9000 --directory public

Want to improve our documentation? Please do! You can open a PR and we'll take a look.

Resources:

• Style Guide