This repository hosts the documentation and user guides for the Thremulation Station project, and is published via github pages at https://docs.thremulation.io.
Instructions on how to spin up a local instance of mkdocs and following steps to add to the project can be found in the contribution guide.
This project is in constant developtment. If you want to jump in, open an issue!
If you just want to see the current version of checked-in content, use the local-deploy script.
- Ensure that you're in the
thremulation.iorepository. - Execute the local deployment script to serve the contents of the
docs/folder on your local machine:
- Start python webserver:
sh local-deploy.sh - Browse to:
http://localhost:8000