https://github.com/michaing/dietpi-docs

Source repository for the DietPi OS documentation
https://github.com/michaing/dietpi-docs

dietpi mkdocs

Last synced: 5 days ago
JSON representation

Source repository for the DietPi OS documentation

• Host: GitHub
• URL: https://github.com/michaing/dietpi-docs
• Owner: MichaIng
• License: cc-by-sa-4.0
• Created: 2020-07-03T19:01:50.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-01T12:05:30.000Z (about 1 month ago)
• Last Synced: 2024-12-06T21:16:33.579Z (27 days ago)
• Topics: dietpi, mkdocs
• Language: HTML
• Homepage: https://dietpi.com/docs/
• Size: 80.7 MB
• Stars: 166
• Watchers: 12
• Forks: 51
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




    Lightweight justice for your single-board computer!

    



    optimised • simplified • for everyone

    



    Website • Downloads • Documentation • Forum • Blog







    Ready to run optimised software choices with dietpi-software

    
Feature-rich configuration tool for your device with dietpi-config.





## Introduction

This is the source code repository for the [DietPi Documentation website](https://dietpi.com/docs/).

It uses extended Markdown, as implemented by [MkDocs](https://www.mkdocs.org/).

[![CodeFactor](https://www.codefactor.io/repository/github/michaing/dietpi-docs/badge)](https://www.codefactor.io/repository/github/michaing/dietpi-docs)

## Building the documentation

- Install/update dependencies: `pip3 install -Ur requirements.txt`

- From the root directory, run: `mkdocs serve`

It builds the static HTML pages into a temporary directory and starts a local web server at `http://localhost:8000`. If you have troubles accessing the MkDocs website, you could also listen on a specific IP address or all IP addresses, e.g. `mkdocs serve -a 0.0.0.0:8000`.

## Contributing

There are many ways you could contribute to DietPi project. You could work on the DietPi project, website design, extend the documentation, or just run tests.

If you have experience with GitHub, you could either look for existent issue to start with or report a new one. Documentation updates should be done directly on GitHub, using the development branch: **[dev](https://github.com/MichaIng/DietPi-Docs/tree/dev)**, creating a pull request (PR).

If you need help:

- Send an email: 

- Read the documentation: 

- Join our forum: 

- GitHub: 

To see the full list of possibilities, please check our [contribution](https://dietpi.com/contribute.html) page.

## Feedback

- Ask a question on our [forum](https://dietpi.com/forum/).

- [File a bug report or request](https://github.com/MichaIng/DietPi-Docs/issues)

- Follow [@DietPi_](https://twitter.com/DietPi_) and let us know what you think!

### GitHub Projects

- DietPi: 

- Documentation: 

- Website: 

## License

DietPi-Docs by DietPi is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License - CC BY-SA 4.0.



This website shows logos of 3rd party software and providers which are excluded from the above license. They may only be used related to their product, for details, check individual trademark rules and licenses.