Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 706 Bytes

README.md

File metadata and controls

25 lines (17 loc) · 706 Bytes

WiiPiiDo Documentation

This repository contains the source files used in the WiiPiiDo online documentation.

Quick Start

This documentation uses MkDocs to generate the online documentation, as well as some plugins.
To start using this projects, install the necessary requirements by running:

pip install -r requirements.txt

When installed, you can start the documentation build process by running:

mkdocs serve

Then you can access the localhost:8000 to check the site and make modifications at run time.

To deploy the documentation to GitHub Pages, simply run:

mkdocs gh-deploy