Next-generation user documentation for the pretix ecosystem.
Using a recent Python environment, install dependencies with:
pip install -r requirements.txt
Then, you can build the project with:
mkdocs serve
And view the local preview at https://127.0.0.1:8000/
On the technical side, this is based on MkDocs and Material for MkDocs so view those pages for in-depth details. A number of plugins are installed that add significant functionality, such as i18n, awesome pages and macros.
:placeholder:ABC:Typographically show that something is to be replaced by the user:btn:Click me:Typographically indicate a clickable UI element:btn-icon:fa3-eye:Click me:Typographically indicate a clickable UI element with an icon and text:btn-icon:fa3-eye::Typographically indicate a clickable UI element with only an icon:navpath:A:B:C:D:Typographically indicate a navigation path where the first element starts on a dynamic spot like "Your Event":rootnavpath:A:B:C:DTypographically indicate a navigation path where the first element is the pretix logo that refers to the backend start page<!-- md:community -->Feature only on pretix Community<!-- md:hosted -->Feature only on pretix Hosted<!-- md:enterprise -->Feature requires pretix Enterprise<!-- md:plugin XY -->Feature requires plugin XY<!-- md:experimental -->Feature is experimental
The contents of this repository are licensed with the Creative Commons Attribution-ShareAlike 4.0 International license. You can find the full license text in the LICENSE file.
If you want to contribute to this project, feel free to send a pull request. If you plan a larger contribution, we encourage you to contact us first to discuss how it fits in the general structure of the project. By contributing to this repository, you agree that your contribution will be published under the before-mentioned Creative Commons license, where "attribution" is sufficiently given if a link to this page (or docs.pretix.eu, where this repository is published) is given, since naming each individual contributor to each file is often not feasible.
You can contact our documentation team through [email protected].