From 9cd4e6f23a0b0a75493f9e4687f87c38fe3586a5 Mon Sep 17 00:00:00 2001 From: Alexander Zobnin Date: Thu, 2 Feb 2017 12:12:10 +0300 Subject: [PATCH] Add docs building instructions. --- docs/README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 0be8737..837f516 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,21 @@ -# Grafana-Zabbix Documentation \ No newline at end of file +# Grafana-Zabbix Documentation + +## Building docs +To build this docs on your computer you need [git-lfs](https://git-lfs.github.com/) and [mkdocs](http://www.mkdocs.org/) installed. + +Clone repo +``` +git clone https://github.com/alexanderzobnin/grafana-zabbix +``` +Check images in `docs/sources/img/`. If this folder is empty, run +``` +git lfs fetch --all +``` + +Build docs +``` +cd docs/ +mkdocs build --clean +``` + +Built docs will be placed in `site/` directory.