This is a repo of the RetroArch official document page.
Go to file
markwkidd 475e9964d7 add xml shader doc to development doc TOC (#248)
* add xml shader doc to development doc TOC

* add xml shaders to shader table

* change xml shader status to discontinued

* clarify that xml shaders are no longer available

* use mkdocs admonition for xml shader warning
2019-02-24 13:16:31 -06: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 add xml shader doc to development doc TOC (#248) 2019-02-24 13:16:31 -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 add xml shader doc to development doc TOC (#248) 2019-02-24 13:16:31 -06:00
README.md Update README.md 2018-04-27 11:06:21 -04:00

Libretro Documentation

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

MkDocs documentation

Material for MkDocs documentation

Libretro Forums topic

Contributing guide

To-do list

travis

Building

  1. Make sure you have Python and pip installed

    python --version
    pip --version
    
  2. Install MkDocs

    pip install mkdocs
    
  3. Install MkDocs-Material

    pip install mkdocs-material
    
  4. Install PyMdown Extensions

    pip install pymdown-extensions
    
  5. Build the site

    mkdocs build
    
  6. The documentation will be built to the site directory