Commit 9c895345 authored by David Hrbáč's avatar David Hrbáč

work on README

parent 9a9ae63f
# 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
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment