README.md 1.45 KB
Newer Older
David Hrbáč's avatar
David Hrbáč committed
1 2 3
# User documentation

This is project contain IT4Innovation user documentation source.
Lukáš Krupčík's avatar
Lukáš Krupčík committed
4

David Hrbáč's avatar
David Hrbáč committed
5
## Environments
David Hrbáč's avatar
David Hrbáč committed
6

David Hrbáč's avatar
David Hrbáč committed
7 8
* https://docs-new.it4i.cz - master branch
* https://docs-new.it4i.cz/devel/$BRANCH_NAME - maps the branches
David Hrbáč's avatar
David Hrbáč committed
9

David Hrbáč's avatar
David Hrbáč committed
10 11 12 13
## URLs

* http://facelessuser.github.io/pymdown-extensions/
* http://squidfunk.github.io/mkdocs-material/
David Hrbáč's avatar
Rules  
David Hrbáč committed
14 15 16

## Rules

David Hrbáč's avatar
David Hrbáč committed
17 18
* spellcheck https://github.com/lukeapage/node-markdown-spellcheck

David Hrbáč's avatar
Rules  
David Hrbáč committed
19 20 21 22 23 24 25 26 27
* SI units http://physics.nist.gov/cuu/Units/checklist.html

```
fair-share
InfiniBand
RedHat
CentOS
Mellanox
```
David Hrbáč's avatar
David Hrbáč committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56

## 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
```