purrbot-site / docs

Repository containing the documentation of the APIs and the wiki of the bot

Docs

This is the source of the PurrBot Documentation containing the Wiki of *Purr* and ImageAPI documentation.
The content is made in Markdown, build using MkDocs with the Material for MkDocs theme and hosted using GitHub Pages.

Contributions

Please take a look at our CONTRIBUTING.md file and also the formatting help on our documentation.

Build Previews

We use a custom Workflow to create previews of Pull requests.
The setup is inspired by the one used by blueedgetechno for win11React (Workflow File)

Credits

A big thank you goes to the following people/groups:

• All maintainers of MkDocs for providing this awesome software to create the pages.
• Squidfunk for creating the Material theme used for these docs.
• Facelessuser for providing the PyMdownX Extension used in these docs.