docs.nefarius.at
The source for the documentation site covering Nefarius' projects on USB input-device emulation, game peripherals and reverse-engineering tooling, built with MkDocs Material.
This repository holds the source for docs.nefarius.at, the documentation site for Nefarius projects related to USB input device emulation, game peripherals, reverse engineering and related tooling. The site is built with MkDocs Material together with several MkDocs plugins, including PyMdown Extensions, Emfed, mkdocs-glightbox and mkdocs-redirects.
A local preview builds with Docker: building an image and running it mounts the repository into the container and serves the site at localhost:8000. Python package versions used for the build are pinned in requirements.txt.
The repository follows a two-branch policy: the master branch is production and is built and deployed to the live site automatically, while the devel branch is staging, for edits that should not go live yet. Contributions are made as pull requests.