Metadata-Version: 2.4
Name: wj-mkdocs
Version: 1.0.0
Summary: MkDocs wrapper bundling a standard Material theme and an !ENV-aware launcher
Project-URL: Documentation, https://docs.waterjuice.org/wj-mkdocs/latest/
Project-URL: Source, https://github.com/WaterJuice/wj-mkdocs
Author: WaterJuice
License-Expression: Unlicense
License-File: LICENSE
Keywords: documentation,material,mkdocs,theme,waterjuice
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: mkdocs-material<=9.7.1
Requires-Dist: mkdocs<2,>=1.0
Requires-Dist: mkdocstrings-python
Requires-Dist: pymdown-extensions
Description-Content-Type: text/markdown

# 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

```bash
# 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

```bash
# 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](LICENSE).
