mdef-docs

Usage

Install Python 3

Python newies! Read the following guide.

Setup

pip install -r requirements.txt

In Windows if it fails use pip install -r requirements.txt --user instead.

Edit

mkdocs serve

In Windows if it fails use python -m mkdocs serve instead.

Deploy

Deploy is done by default via Github Action. See /.github/workflows/main.yml.

For custom installations you can use mkdocs gh-deploy.