kobol-wiki/README.md

# Kobol Offical Wiki

Powered by mkdocs : http://www.mkdocs.org/

### Template
Material : http://squidfunk.github.io/mkdocs-material/

### Extension
Lightgallery : https://github.com/g-provost/lightgallery-markdown

## How to run this wiki locally

1. Install mkdocs

```bash
$ pip3 install mkdocs
```

2. Install Material Template

```bash
$ pip3 install mkdocs-material
```

3. Install git-revision plugin

```bash
pip3 install mkdocs-git-revision-date-localized-plugin
```

4. Install Lightgallery Extension

```bash
$ git clone https://github.com/g-provost/lightgallery-markdown.git

$ cd lightgallery-markdown

$ python3 setup.py install
```

5. Download and serve wiki

```bash
$ git clone https://github.com/kobol-io/wiki.git

$ cd wiki

$ mkdocs serve
```