From 9c8953454a5d6c71e0d9f605b8efbf53b67af438 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Hrb=C3=A1=C4=8D?= <david@hrbac.cz> Date: Tue, 24 Jan 2017 14:43:31 +0100 Subject: [PATCH] work on README --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b68f738eb..baa0ca6b2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# User documentation - TEST +# User documentation + +This is project contain IT4Innovation user documentation source. ## Environments @@ -23,3 +25,32 @@ RedHat CentOS Mellanox ``` + +## Developemnt Environment + +### MkDocs + +Documentation pages are build with [MkDocs](http://www.mkdocs.org/), [MkDocs at GitHub](https://github.com/mkdocs/mkdocs/). You need to install mkdocs loacally so that you can build the pages and run developement web server. + +```bash +pip install mkdocs pygments pymdown-extensions +``` +You can build the pages with `mkdocs build`. + +```bash +‹hrb33-toshiba› 11:47 $ mkdocs build +INFO - Cleaning site directory +INFO - Building documentation to directory: /home/hrb33/Dokumenty/dev/it4i/docs.it4i.git/site +``` + +You can start local server with `mkdocs serve`. + +```bash +✔ ~/Dokumenty/dev/it4i/docs.it4i.git [readme L|✚ 1…6⚑ 1] +‹hrb33-toshiba› 11:47 $ mkdocs serve +INFO - Building documentation... +INFO - Cleaning site directory +[I 170124 11:47:27 server:283] Serving on http://127.0.0.1:8000 +[I 170124 11:47:27 handlers:60] Start watching changes +[I 170124 11:47:27 handlers:62] Start detecting changes +``` -- GitLab