wj-mkdocs 1.0.0

MkDocs wrapper bundling a standard Material theme and an !ENV-aware launcher

wj-mkdocs

A WaterJuice project.

A PyPI package that bundles a standard MkDocs theme and a small Python program that sets up environment variables to point to the various documents and then executes MkDocs.

This allows config files to use !ENV to point to the actual files wherever they are installed on the system.

Installation

# Using uv
uv pip install wj-mkdocs

# Using pip
pip install wj-mkdocs

Themes

To use the theme add the line to the top of the mkdocs.yml file:

INHERIT: !ENV THEME_STD

• THEME_STD - Standard Material for MkDocs theme.

Included Packages

This package includes the following packages so they don't need to be specified:

• mkdocs (1.x.x)
• mkdocs-material (<=9.7.1)
• mkdocstrings-python
• pymdown-extensions

Development

# Set up development environment
make dev

# Run linting and type checks
make check

# Format code
make format

# Build wheel and docs
make build

License

Released into the public domain under the Unlicense.