Undernet Charter (charter.undernet.org)

MkDocs

The documentation is written in MarkDown and uses the MkDocs framework.

Usage

There are currently two ways to run MkDocs locally to preview changes in real-time.

Local installation

Requirements:*

• Python 3.x
• pipenv

Installing MkDocs using pipenv

$ pipenv install

Running MkDocs

$ pipenv shell
$ mkdocs serve

Using docker and docker-compose

$ docker-compose up