kobol-wiki/README.md

50 lines
764 B
Markdown
Raw Normal View History

2017-09-27 11:20:50 +02:00
# Kobol Offical Wiki
2017-10-10 18:03:56 +02:00
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
2019-07-17 08:05:17 +02:00
$ pip3 install mkdocs
```
2. Install Material Template
```bash
2019-07-17 08:05:17 +02:00
$ 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
2019-07-17 08:05:17 +02:00
$ python3 setup.py install
```
2019-07-17 08:05:17 +02:00
5. Download and serve wiki
```bash
2020-04-21 06:12:14 +02:00
$ git clone https://github.com/kobol-io/wiki.git
2017-12-24 17:56:49 +01:00
$ cd wiki
2017-12-21 07:34:43 +01:00
$ mkdocs serve
```