Advanced Peripherals Documentation

This is the source of the documentation for Advanced Peripherals.
The documentation is built with mkdocs.
I recommend using mkdocs if you want to contribute, but you do not need to.

Site

The docs can be viewed at any of the below:
https://docs.intelligence-modding.de/
https://advancedperipherals.madefor.cc/
https://advancedperipherals.netlify.app/

Contributing

If you want to contribute, fork this repository then in your fork make changes to the file you want to edit or add new files. Once you have made the changes make a pull request to contribute your changes to this repository. You can use mkdocs if you want to see your changes live, you will need Material for Mkdocs and Python to get it running.

Setup with Poetry

You will need to install Poetry for Python to use this setup.
Install mkdocs dependencies by running:

poetry install

⚠️ Make sure you are in the folder with the pyproject.toml file

Once dependencies have been installed you can now serve with mkdocs to view your changes:

poetry run mkdocs serve

Click the url in your terminal to open the docs in your browser.

---

Setup with Pip

If you have python installed on your machine you will have pip installed.
Install the necessary dependencies by running:

pip install -r requirements.txt

⚠️ Make sure you are in the folder with the requirements.txt file

Once dependencies have been installed you can now serve with mkdocs to view your changes:

python -m mkdocs serve

Click the url in your terminal to open the docs in your browser.