DietPi Docs
Source repository for the DietPi OS documentation
Overview
The DietPi Documentation website source code repository uses extended Markdown implemented by MkDocs. It provides detailed instructions on building and updating the documentation, contributing to the DietPi project, and provides resources for feedback and support. The project is open for contributions on GitHub and is licensed under CC BY-SA 4.0.
Features
- Markdown with MkDocs: Utilizes extended Markdown for easy documentation writing.
- CodeFactor: Includes tools like CodeFactor for code quality assessments.
- Contributing Guidelines: Offers various ways to contribute to the DietPi project.
- Feedback Channels: Provides multiple channels for users to ask questions, report bugs, or provide feedback.
- GitHub Projects: Links to repositories for the DietPi project, documentation, and website.
- License Information: Clearly states the license under which the documentation is published.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
