libretro/docs

mirror of https://github.com/libretro/docs.git synced 2024-11-23 16:59:40 +00:00

This is a repo of the RetroArch official document page.

Go to file

Twinaphex fca3a374b3 Update mkdocs.yml		2018-08-17 15:05:34 +02:00
.github	Update see_also.md, CONTRIBUTING.md, how-to-contribute.md	2018-04-29 11:30:36 -04:00
docs	Update windowsXP.md	2018-08-17 15:05:07 +02:00
.gitignore	Initial commit	2018-02-23 10:11:21 +01:00
.travis.yml	Initial commit	2018-02-23 10:11:21 +01:00
deploy	fix executable bit again	2018-05-01 08:09:37 -04:00
LICENSE	Initial commit	2018-02-23 10:11:21 +01:00
Makefile	Initial commit	2018-02-23 10:11:21 +01:00
mkdocs.yml	Update mkdocs.yml	2018-08-17 15:05:34 +02:00
README.md	Update README.md	2018-04-27 11:06:21 -04:00

README.md

Libretro Documentation

This is the source for the libretro documentation, powered by MkDocs.

MkDocs documentation

Material for MkDocs documentation

Libretro Forums topic

Contributing guide

Building

Make sure you have Python and pip installed
```
python --version
pip --version
```
Install MkDocs
```
pip install mkdocs
```
Install MkDocs-Material
```
pip install mkdocs-material
```
Install PyMdown Extensions
```
pip install pymdown-extensions
```
Build the site
```
mkdocs build
```
The documentation will be built to the site directory