mailcow-dockerized-docs/README.md
2022-02-06 00:00:18 +01:00

18 Zeilen
860 B
Markdown

> ⚠️: _**This branch of the mailcow docs is deprecated!**_<br>
> All Old Pull requests have been closed in case of incompatibility.<br>
> This Branch is for archiving purposes only!
# mailcow: dockerized documentation
This project aims to provide the mailcow: dockerized documentation for the [mailcow: dockerized](https://github.com/mailcow/mailcow-dockerized) project.
https://mailcow.github.io/mailcow-dockerized-docs
To build it locally, you need the [Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/), [MkDocs](https://www.mkdocs.org/) itself and [Pygments](http://pygments.org/). To install these with [pip](https://pip.pypa.io/en/stable/) and get it up and running, fire up your terminal and enter
```
git clone https://github.com/mailcow/mailcow-dockerized-docs.git
pip install -r requirements.txt
mkdocs serve
```