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/
|
|
|
|
|
|
2017-12-21 07:20:45 +01:00
|
|
|
### Template
|
|
|
|
|
Material : http://squidfunk.github.io/mkdocs-material/
|
2017-12-19 12:05:07 +01:00
|
|
|
|
2017-12-21 07:20:45 +01:00
|
|
|
### 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
|
2017-12-21 07:20:45 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
2. Install Material Template
|
|
|
|
|
|
|
|
|
|
```bash
|
2019-07-17 08:05:17 +02:00
|
|
|
$ pip3 install mkdocs-material
|
2017-12-21 07:20:45 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. 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
|
2017-12-21 07:20:45 +01:00
|
|
|
```
|
|
|
|
|
|
2019-07-17 08:05:17 +02:00
|
|
|
4. Install git-revision plugin
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
pip3 install mkdocs-git-revision-date-plugin
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
5. Download and serve wiki
|
2017-12-21 07:20:45 +01:00
|
|
|
|
|
|
|
|
```bash
|
2017-12-24 17:56:49 +01:00
|
|
|
$ git clone https://github.com/helios-4/wiki.git
|
|
|
|
|
|
|
|
|
|
$ cd wiki
|
2017-12-21 07:34:43 +01:00
|
|
|
|
2017-12-21 07:20:45 +01:00
|
|
|
$ mkdocs serve
|
|
|
|
|
```
|
