libretro/docs

mirror of https://github.com/libretro/docs.git synced 2024-11-27 18:50:37 +00:00

This is a repo of the RetroArch official document page.

Go to file

Twinaphex a3e5592934 Merge pull request #232 from markwkidd/patch-5 improve visibility of "contributing to the docs"		2019-02-22 18:44:45 +01:00
.github	Update see_also.md, CONTRIBUTING.md, how-to-contribute.md	2018-04-29 11:30:36 -04:00
archive	add tex/lyx original versions of archival PDFs (#227 )	2019-02-19 11:39:49 -06:00
docs	shader dev guide format and section order fixes (#231 )	2019-02-21 14:41:34 -06:00
.editorconfig	organize development docs TOC / add git file format directives (#222 )	2019-02-18 13:06:11 -06:00
.gitattributes	organize development docs TOC / add git file format directives (#222 )	2019-02-18 13:06:11 -06:00
.gitignore	Initial commit	2018-02-23 10:11:21 +01:00
.travis.yml	syntax	2018-11-20 16:59:38 -03: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	Merge pull request #232 from markwkidd/patch-5	2019-02-22 18:44:45 +01: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