Changelog¶
This page mirrors CHANGELOG.md in the repository.
[Unreleased]¶
Changed (docs site and release scripts)¶
- Documentation moved from the hand-written Jekyll site in
docs/to ProperDocs + MaterialX: source insrc_docs/md/(9 pages), config insrc_docs/mkdocs.yml, built intodocs/bysrc_docs/build.shand the newDocsworkflow. Published at https://vexy.dev/vexy-mkdocs-tools/. build.shbuilds docs and/or the package (./build.sh [all|docs|package]);publish.shtags withgitnextver, builds and uploads withuv publish.release.ymlpublishes withskip-existing: true, so a version already uploaded bypublish.shdoes not fail the workflow.pyproject.tomlgains aDocumentationURL.
Added¶
- End-to-end tests that build a real fixture site (
src_docs/md+mkdocs.yml→docs/) withproperdocs, asserting the page renders,.nojekyllis written, and asrc_docs/md/CNAMEis copied into the output. Skip gracefully whenproperdocsis not on PATH. - Jekyll documentation site under
docs/(Just the Docs remote theme) documenting themkdocs/mkdocs.yml+src_docs/md/→docs/contract, thematerialxtheme name, and theCNAMEconvention. CLAUDE.mdwiththis_file:map and pipeline notes for contributors.TODO.mdcapturing path-to-v1.0, robustness ideas, and known behavior notes.
Changed¶
.gitignorenow excludes macOS.DS_Storeand friends.
[0.1.0]¶
Added¶
- First PyPI release as
vexy-mkdocs-tools. build.shrunsuvx hatch cleanbefore building;publish.shrunsgitnextver ..
[Unreleased]¶
Added¶
- Initial scaffolding:
pyproject.tomlwith hatchling + hatch-vcs,requires-python = ">=3.12". src/vexy_mkdocs_tools/cli.py— Fire CLI withbuild,serve,clean,format,version.- Console-script entry points
vexy-mkdocs-toolsandvmt. - Bundled dependencies: ProperDocs 1.6.7+, MaterialX 10.1.4+,
pymdown-extensions,mkdocs-awesome-nav,mkdocs-include-markdown-plugin,mkdocs-llmstxt,mkdocs-copy-to-llm,mkdocs-rss-plugin. - Optional
[flowmark]extra for in-place Markdown formatting. tests/test_cli.py— pytest smoke tests for_clean_docs(CNAME preservation) and_find_repo_root(walk-up + missing-root error).build.sh,publish.sh— local build/publish wrappers.- GitHub Actions:
ci.yml(test on push/PR),release.yml(publish to PyPI onv*.*.*tag). - README with usage, layout convention, and dev workflow.