From 97034a13a385d78fb487ed395723f81b6f216cb3 Mon Sep 17 00:00:00 2001 From: Niklas Meyer <62480600+DerLinkman@users.noreply.github.com> Date: Mon, 31 Jan 2022 20:15:29 +0100 Subject: [PATCH] Update README.md --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index e656909dc..701489b53 100644 --- a/README.md +++ b/README.md @@ -113,3 +113,14 @@ docs <-- Root Folder │   ├── file.XX.md ``` +--- + +### Testing + +To build and test 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 +```