kobol-wiki/README.md
Gauthier Provost 5ba93f2c13
Helios64 Hardware Detailed Info (#27)
* Add detailed hardware info for Helios64
    - Button
    - Ethernet
    - Front Panel
    - GPIO
    - I2C
    - Jumper
    - LED
    - M.2
    - PMIC
    - PWM Fan
    - RTC
    - SATA
    - SPI
    - UEXT
    - UPS
    - USB

* Cosmetic upgrade and adapt to latest mkdocs-material version

Co-authored-by: nurix <nurix@pnsnc.local>
Co-authored-by: Aditya Prayoga <aditya@kobol.io>
2020-04-20 16:06:24 +08:00

50 lines
764 B
Markdown

# 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/helios-4/wiki.git
$ cd wiki
$ mkdocs serve
```