Developing

Prerequisites

You will need to have MKDocs installed on your system. I recommend installing it via pip to get the latest version.

sudo apt-get update
sudo apt-get install -y --no-install-recommends \
 python3-pip \
 libcairo2-dev \
 libfreetype6-dev \
 libffi-dev \
 libjpeg-dev \
 libpng-dev \
 libz-dev
pip install --upgrade pip
pip install --user -r requirements.txt

Building

Building this package requires using mkdocs_simple_gen to generate the site.

mkdocs_simple_gen --build -- --verbose

Testing

Unit tests

Unit tests help ensure individual functions perform as expected. Unit tests in this module use the the standard python unittest framework.

./tests/run_unit_tests.sh

Code

python3 -m unittest tests/test_*.py

VSCode

Included in this package is a VSCode workspace and development container. See how I develop with VSCode and Docker and how I use VSCode tasks.

Packaging

The project uses Hatch to build and package the plugin

Build the package

hatch build

Publish the package

hatch publish