mailcow-dockerized-docs/README.md

15 Zeilen
858 B
Markdown

2021-04-20 22:01:23 +02:00
[![Build and deploy to gh-pages](https://github.com/mailcow/mailcow-dockerized-docs/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/mailcow/mailcow-dockerized-docs/actions/workflows/gh-pages.yml)
2017-06-12 14:37:47 +02:00
2019-10-14 18:35:17 +02:00
# mailcow: dockerized documentation
2020-04-21 23:34:34 +02:00
This project aims to provide the mailcow: dockerized documentation for the [mailcow: dockerized](https://github.com/mailcow/mailcow-dockerized) project.
2017-05-02 21:36:57 +02:00
https://mailcow.github.io/mailcow-dockerized-docs
2019-10-19 15:21:39 +02:00
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
```
pip install mkdocs-material==7.2.6 pygments==2.10.0 mkdocs-redirects==1.0.3
2019-10-19 15:21:39 +02:00
mkdocs serve
2021-05-03 01:13:15 +02:00
```