Contributing to documentation

We use MkDocs and Github pages for the documentation site you're reading right now.

How to get started

1. Clone the pylon-docs repository: git clone https://github.com/pylonmc/pylon-docs
2. Install MkDocs using pip: pip install mkdocs
3. Install the MkDocs material theme: pip install mkdocs-material
4. Run the documentation website locally using mkdocs serve

Deploying

Only core members can deploy the website.

1. Clone the pylonmc.github.io repository: git clone https://github.com/pylonmc/pylonmc.github.io
2. Deploy the site by running in the pylonmc.github.io repository mkdocs gh-deploy --config-file ../pylon-docs/mkdocs.yml --remote-branch master