This is a static site built using the MkDocs
platform with the theme Material for MkDocs
, which expands upon MkDocs functionality to allow for even more robust and customizable documentation website building.
- Info on MkDocs here: https://www.mkdocs.org
- Info on Material for MkDocs here: https://squidfunk.github.io/mkdocs-material
Documentation is written in Markdown and is converted into HTML automatically by the MkDocs build tool. For help with Markdown, see the Basic writing and formatting syntax on GitHub.
The navigation for the website (e.g. the tabs at the top, the order and hierarchy of pages in the navigation sidebar) is configured in mkdocs.yml.
After commits are made to this repo, a GitHub action runs that re-builds the website. Once this is done, the website will refresh with the changes.
You're welcome to contribute to this documentation whether you're a Deluge Community Firmware contributor or just an enthusiastic Deluge user. To get started, see Contributing to the Docs