diff --git a/README.md b/README.md index 443314c559cfe20f0fbb64151e22cc16c7d86a06..cf8f9e087b1b2895d66171bd7ac5fa2fa478249c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@ -User documentation -================== +# User documentation -Environments ------------- +This is project contain IT4Innovation user documentation source. + +## Environments * [https://docs-new.it4i.cz - master branch](https://docs-new.it4i.cz - master branch) * [https://docs-new.it4i.cz/devel/$BRANCH_NAME](https://docs-new.it4i.cz/devel/$BRANCH_NAME) - maps the branches -URLs ----- +## URLs * [http://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/) * [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/) -Rules ------ +## Rules * [spellcheck https://github.com/lukeapage/node-markdown-spellcheck](spellcheck https://github.com/lukeapage/node-markdown-spellcheck) @@ -27,3 +25,33 @@ 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 +```