MkDocs

Overview

PGC uses MkDocs to create documentation webpage from markdown files, to set up the documentation page locally, follow these steps:

Follow the usage on section 2 (Setup Virtual Environment) first, then you can continue following this guide.

Run this command on the project root directory

mkdocs serve

This will run the MkDocs server locally, usually at http://127.0.0.1:8000/ or other address as it shown in your shell.