Skip to content
Snippets Groups Projects
Commit 96a64f67 authored by David Hrbáč's avatar David Hrbáč
Browse files

Merge branch 'readme' into 'master'

work on README

See merge request !54
parents 42c6c77a bb4fdf1a
No related branches found
No related tags found
5 merge requests!368Update prace.md to document the change from qprace to qprod as the default...,!367Update prace.md to document the change from qprace to qprod as the default...,!366Update prace.md to document the change from qprace to qprod as the default...,!323extended-acls-storage-section,!54work on README
Pipeline #
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 - 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 * [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://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/)
* [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/) * [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) * [spellcheck https://github.com/lukeapage/node-markdown-spellcheck](spellcheck https://github.com/lukeapage/node-markdown-spellcheck)
...@@ -27,3 +25,33 @@ RedHat ...@@ -27,3 +25,33 @@ RedHat
CentOS CentOS
Mellanox 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
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment