Changelog¶
All notable changes to vexy-mkdocs-markdown-in-template. The same list is in
CHANGELOG.md in the repository.
[Unreleased]¶
Changed¶
- Documentation moved from Jekyll (
docs/index.md,docs/_config.yml) to a ProperDocs + MaterialX site: sources insrc_docs/md/(11 pages), config insrc_docs/mkdocs.yml, built intodocs/bysrc_docs/build.shand published at https://vexy.dev/vexy-mkdocs-markdown-in-template/. The site dog-foods the plugin insrc_docs/overrides/main.html. build.shnow takesall|docs|package;publish.shtags withgitnextver, builds and uploads withuv publish.release.ymlpublishes withskip-existing: true.
Added¶
.github/workflows/docs.ymlrebuildsdocs/on pushes tomain.DocumentationURL in the package metadata.
[1.0.5]¶
Added¶
- Test suite (
tests/test_plugin.py): unit tests for dedent/reset/config plus a fullmkdocs buildintegration test that renders{% md %}in a theme partial. - GitHub Actions:
ci.yml(pytest on Python 3.12/3.13 × Linux/Windows, an MkDocs 1.5/1.6 compatibility matrix, and ruff + mypy lint) andrelease.yml(build, trusted-publish to PyPI, GitHub Release with changelog extraction). - Jekyll + Just the Docs documentation in
docs/(_config.yml,index.md). - Project icon at
docs/assets/icon.png. mypy+types-Markdowndev dependencies; pytest and mypy tool config.
Fixed¶
- The shared
markdown.Markdowninstance is now reset between blocks, so footnotes and references no longer leak from one{% md %}block into the next.
Changed¶
- Added type hints and docstrings throughout
plugin.py; dropped the unusedenabled/dirsattributes.
[1.0.1]¶
Changed¶
- Renamed PyPI distribution to
vexy-mkdocs-markdown-in-template. - Added a
pyproject.toml(hatchling + hatch-vcs, VCS-derived version inmkdocs_markdown_in_template_plugin/__version__.py, gitignored);requires-python = ">=3.12". __init__.pynow imports__version__from the generated module.- Repo URLs moved to the
vexyartorg.
Removed¶
setup.py,requirements.txt.
Added¶
build.sh/publish.shconvention scripts.