vexy-mkdocs-tools 0.1.0__tar.gz

vexy_mkdocs_tools-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# hatch-vcs generated
+src/vexy_mkdocs_tools/__version__.py
+

vexy_mkdocs_tools-0.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [0.1.0]
+
+### Added
+- First PyPI release as `vexy-mkdocs-tools`.
+- `build.sh` runs `uvx hatch clean` before building; `publish.sh` runs `gitnextver .`.
+
+## [Unreleased]
+
+### Added
+- Initial scaffolding: `pyproject.toml` with hatchling + hatch-vcs, `requires-python = ">=3.12"`.
+- `src/vexy_mkdocs_tools/cli.py` — Fire CLI with `build`, `serve`, `clean`, `format`, `version`.
+- Console-script entry points `vexy-mkdocs-tools` and `vmt`.
+- 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 on `v*.*.*` tag).
+- README with usage, layout convention, and dev workflow.

vexy_mkdocs_tools-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vexy_mkdocs_tools-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: vexy-mkdocs-tools
+Version: 0.1.0
+Summary: Fire-based CLI that bundles ProperDocs + MaterialX + the vexy mkdocs plugin set, for one-shot site builds via `uvx vexy-mkdocs-tools build`.
+Project-URL: Homepage, https://github.com/vexyart/vexy-mkdocs-tools
+Project-URL: Repository, https://github.com/vexyart/vexy-mkdocs-tools
+Project-URL: Issues, https://github.com/vexyart/vexy-mkdocs-tools/issues
+Project-URL: Changelog, https://github.com/vexyart/vexy-mkdocs-tools/blob/main/CHANGELOG.md
+Author-email: Adam Twardoch <adam+github@twardoch.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cli,materialx,mkdocs,properdocs,static-site
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: MkDocs
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.12
+Requires-Dist: fire>=0.7
+Requires-Dist: loguru>=0.7
+Requires-Dist: mkdocs-awesome-nav>=3.3
+Requires-Dist: mkdocs-copy-to-llm>=0.2
+Requires-Dist: mkdocs-include-markdown-plugin>=7.2
+Requires-Dist: mkdocs-llmstxt>=0.2
+Requires-Dist: mkdocs-materialx>=10.1.4
+Requires-Dist: mkdocs-rss-plugin>=1.17
+Requires-Dist: properdocs>=1.6.7
+Requires-Dist: pymdown-extensions>=10.2
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.1; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: flowmark
+Requires-Dist: flowmark>=0.6.5; extra == 'flowmark'
+Description-Content-Type: text/markdown
+
+# vexy-mkdocs-tools
+
+Fire-based CLI that bundles [ProperDocs](https://github.com/jaywhj/properdocs) + [MaterialX](https://github.com/jaywhj/mkdocs-materialx) and the standard `vexy-` plugin set, so a site builds in one shot:
+
+```bash
+uvx vexy-mkdocs-tools build
+```
+
+## Why
+
+Every FontLab/Vexy MkDocs-style site repeats the same dependency list and the same wrapper script (clean `docs/` but keep `CNAME`, optionally Flowmark-format `src_docs/md/` first, then `properdocs build`, then write `.nojekyll`). This package owns the dependency set and the wrapper, so site repos shrink to "Markdown + `mkdocs.yml`".
+
+## Install
+
+```bash
+uv pip install vexy-mkdocs-tools           # site builds
+uv pip install "vexy-mkdocs-tools[flowmark]" # also Flowmark formatting
+```
+
+Or ad-hoc without installing:
+
+```bash
+uvx vexy-mkdocs-tools build
+uvx --with flowmark vexy-mkdocs-tools build
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `vmt build` | Flowmark-format `src_docs/md/` (if available) → wipe `docs/` (preserving `CNAME`) → `properdocs build` → write `.nojekyll` |
+| `vmt build --no-format` | Skip the Flowmark step |
+| `vmt serve` | `properdocs serve` with the same config |
+| `vmt clean` | Wipe `docs/` (preserving `CNAME`) without rebuilding |
+| `vmt format` | Run Flowmark in place over `src_docs/md/` |
+| `vmt version` | Print installed version |
+
+`vexy-mkdocs-tools` and `vmt` are aliases.
+
+## Site layout assumed
+
+```
+<repo>/
+├── mkdocs/mkdocs.yml     # config (--config to override)
+├── src_docs/md/          # Markdown source (--src to override)
+└── docs/                 # build output (--docs to override)
+```
+
+The CLI walks up from `cwd` until it finds a directory containing both `mkdocs/mkdocs.yml` and `src_docs/`. Pass `--root` to skip the walk.
+
+## Bundled dependencies
+
+ProperDocs 1.6.7+, MaterialX 10.1.4+, plus `pymdown-extensions`, `mkdocs-awesome-nav`, `mkdocs-include-markdown-plugin`, `mkdocs-llmstxt`, `mkdocs-copy-to-llm`, `mkdocs-rss-plugin`. The `[flowmark]` extra adds `flowmark`.
+
+## Develop
+
+```bash
+uv sync --extra dev
+uv run python -m pytest -q
+uvx ruff check src tests
+./build.sh    # full build + test + wheel/sdist
+./publish.sh  # upload to PyPI (needs UV_PUBLISH_TOKEN)
+```
+
+Releases are tag-driven — push a `vX.Y.Z` tag and the `release` workflow ships to PyPI.
+
+## License
+
+Apache-2.0.

vexy_mkdocs_tools-0.1.0/README.md

@@ -0,0 +1,69 @@
+# vexy-mkdocs-tools
+
+Fire-based CLI that bundles [ProperDocs](https://github.com/jaywhj/properdocs) + [MaterialX](https://github.com/jaywhj/mkdocs-materialx) and the standard `vexy-` plugin set, so a site builds in one shot:
+
+```bash
+uvx vexy-mkdocs-tools build
+```
+
+## Why
+
+Every FontLab/Vexy MkDocs-style site repeats the same dependency list and the same wrapper script (clean `docs/` but keep `CNAME`, optionally Flowmark-format `src_docs/md/` first, then `properdocs build`, then write `.nojekyll`). This package owns the dependency set and the wrapper, so site repos shrink to "Markdown + `mkdocs.yml`".
+
+## Install
+
+```bash
+uv pip install vexy-mkdocs-tools           # site builds
+uv pip install "vexy-mkdocs-tools[flowmark]" # also Flowmark formatting
+```
+
+Or ad-hoc without installing:
+
+```bash
+uvx vexy-mkdocs-tools build
+uvx --with flowmark vexy-mkdocs-tools build
+```
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `vmt build` | Flowmark-format `src_docs/md/` (if available) → wipe `docs/` (preserving `CNAME`) → `properdocs build` → write `.nojekyll` |
+| `vmt build --no-format` | Skip the Flowmark step |
+| `vmt serve` | `properdocs serve` with the same config |
+| `vmt clean` | Wipe `docs/` (preserving `CNAME`) without rebuilding |
+| `vmt format` | Run Flowmark in place over `src_docs/md/` |
+| `vmt version` | Print installed version |
+
+`vexy-mkdocs-tools` and `vmt` are aliases.
+
+## Site layout assumed
+
+```
+<repo>/
+├── mkdocs/mkdocs.yml     # config (--config to override)
+├── src_docs/md/          # Markdown source (--src to override)
+└── docs/                 # build output (--docs to override)
+```
+
+The CLI walks up from `cwd` until it finds a directory containing both `mkdocs/mkdocs.yml` and `src_docs/`. Pass `--root` to skip the walk.
+
+## Bundled dependencies
+
+ProperDocs 1.6.7+, MaterialX 10.1.4+, plus `pymdown-extensions`, `mkdocs-awesome-nav`, `mkdocs-include-markdown-plugin`, `mkdocs-llmstxt`, `mkdocs-copy-to-llm`, `mkdocs-rss-plugin`. The `[flowmark]` extra adds `flowmark`.
+
+## Develop
+
+```bash
+uv sync --extra dev
+uv run python -m pytest -q
+uvx ruff check src tests
+./build.sh    # full build + test + wheel/sdist
+./publish.sh  # upload to PyPI (needs UV_PUBLISH_TOKEN)
+```
+
+Releases are tag-driven — push a `vX.Y.Z` tag and the `release` workflow ships to PyPI.
+
+## License
+
+Apache-2.0.

vexy_mkdocs_tools-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+# this_file: pyproject.toml
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vexy-mkdocs-tools"
+dynamic = ["version"]
+description = "Fire-based CLI that bundles ProperDocs + MaterialX + the vexy mkdocs plugin set, for one-shot site builds via `uvx vexy-mkdocs-tools build`."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+authors = [
+    { name = "Adam Twardoch", email = "adam+github@twardoch.com" },
+]
+keywords = ["mkdocs", "properdocs", "materialx", "static-site", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Framework :: MkDocs",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Documentation",
+]
+dependencies = [
+    "fire>=0.7",
+    "loguru>=0.7",
+    "properdocs>=1.6.7",
+    "mkdocs-materialx>=10.1.4",
+    "pymdown-extensions>=10.2",
+    "mkdocs-awesome-nav>=3.3",
+    "mkdocs-include-markdown-plugin>=7.2",
+    "mkdocs-llmstxt>=0.2",
+    "mkdocs-copy-to-llm>=0.2",
+    "mkdocs-rss-plugin>=1.17",
+]
+
+[project.optional-dependencies]
+flowmark = [
+    "flowmark>=0.6.5",
+]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=4.1",
+    "ruff>=0.6",
+]
+
+[project.urls]
+Homepage = "https://github.com/vexyart/vexy-mkdocs-tools"
+Repository = "https://github.com/vexyart/vexy-mkdocs-tools"
+Issues = "https://github.com/vexyart/vexy-mkdocs-tools/issues"
+Changelog = "https://github.com/vexyart/vexy-mkdocs-tools/blob/main/CHANGELOG.md"
+
+[project.scripts]
+vexy-mkdocs-tools = "vexy_mkdocs_tools.cli:main"
+vmt = "vexy_mkdocs_tools.cli:main"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/vexy_mkdocs_tools/__version__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/vexy_mkdocs_tools"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/CHANGELOG.md",
+    "/LICENSE",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+ignore = ["E501"]

vexy_mkdocs_tools-0.1.0/src/vexy_mkdocs_tools/__init__.py

@@ -0,0 +1,11 @@
+# this_file: src/vexy_mkdocs_tools/__init__.py
+"""vexy-mkdocs-tools: Fire CLI wrapper around ProperDocs/MaterialX."""
+
+from __future__ import annotations
+
+try:
+    from vexy_mkdocs_tools.__version__ import __version__
+except ImportError:  # editable install before hatch-vcs has run
+    __version__ = "0.0.0+local"
+
+__all__ = ["__version__"]

vexy_mkdocs_tools-0.1.0/src/vexy_mkdocs_tools/__main__.py

@@ -0,0 +1,7 @@
+# this_file: src/vexy_mkdocs_tools/__main__.py
+"""Allow `python -m vexy_mkdocs_tools ...`."""
+
+from vexy_mkdocs_tools.cli import main
+
+if __name__ == "__main__":
+    main()

vexy_mkdocs_tools-0.1.0/src/vexy_mkdocs_tools/__version__.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = None

vexy_mkdocs_tools-0.1.0/src/vexy_mkdocs_tools/cli.py

@@ -0,0 +1,213 @@
+# this_file: src/vexy_mkdocs_tools/cli.py
+"""Fire CLI for vexy-mkdocs-tools.
+
+Wraps ProperDocs build/serve with the conventions used by the FontLab/Vexy
+sites: a `mkdocs/mkdocs.yml` config, a `docs/` output directory whose `CNAME`
+is preserved across cleans, and an optional Flowmark formatting pass over
+`src_docs/md/` before each build.
+
+Usage::
+
+    uvx vexy-mkdocs-tools build              # full build pipeline
+    uvx vexy-mkdocs-tools serve              # live-reload preview
+    uvx vexy-mkdocs-tools clean              # wipe docs/ but keep CNAME
+    uvx vexy-mkdocs-tools format             # Flowmark in-place format
+
+Site layout (overridable via flags / constructor args)::
+
+    <root>/
+        mkdocs/mkdocs.yml
+        src_docs/md/
+        docs/                 (build output)
+"""
+
+from __future__ import annotations
+
+import shlex
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+import fire
+from loguru import logger
+
+
+class BuildError(RuntimeError):
+    """Raised when the build pipeline cannot proceed."""
+
+
+def _configure_logging(verbose: bool) -> None:
+    import os
+
+    level = "DEBUG" if verbose else os.environ.get("VMT_LOG_LEVEL", "INFO").upper()
+    logger.remove()
+    logger.add(sys.stderr, level=level, format="<level>{level: <8}</level> | {message}")
+
+
+def _find_repo_root(start: Path | None = None) -> Path:
+    """Walk up until we find a dir containing both `mkdocs/mkdocs.yml` and `src_docs`."""
+    cur = (start or Path.cwd()).resolve()
+    for candidate in [cur, *cur.parents]:
+        if (candidate / "mkdocs" / "mkdocs.yml").is_file() and (
+            candidate / "src_docs"
+        ).is_dir():
+            return candidate
+    raise BuildError(
+        "cannot locate site root (no mkdocs/mkdocs.yml + src_docs/ found "
+        "walking up from cwd). Pass --root explicitly."
+    )
+
+
+def _clean_docs(docs_dir: Path) -> None:
+    """Remove everything in `docs_dir` except `CNAME`. Recreate if missing."""
+    if not docs_dir.exists():
+        docs_dir.mkdir(parents=True, exist_ok=True)
+        logger.info(f"Created {docs_dir}")
+        return
+    cname_content: str | None = None
+    cname_path = docs_dir / "CNAME"
+    if cname_path.is_file():
+        cname_content = cname_path.read_text(encoding="utf-8")
+        logger.debug(f"Preserving CNAME: {cname_content.strip()!r}")
+    for child in docs_dir.iterdir():
+        if child.name == "CNAME":
+            continue
+        if child.is_dir() and not child.is_symlink():
+            shutil.rmtree(child)
+        else:
+            child.unlink()
+        logger.debug(f"Removed {child}")
+    if cname_content is not None:
+        cname_path.write_text(cname_content, encoding="utf-8")
+    logger.info(f"Cleaned {docs_dir} (preserved CNAME)")
+
+
+def _run(cmd: list[str], cwd: Path) -> None:
+    logger.info(f"Running: {shlex.join(cmd)}")
+    subprocess.run(cmd, check=True, cwd=cwd)
+
+
+def _flowmark_available() -> bool:
+    return shutil.which("flowmark") is not None
+
+
+def _format_with_flowmark(src_docs_dir: Path, root: Path) -> None:
+    if not src_docs_dir.is_dir():
+        raise BuildError(f"source Markdown directory missing: {src_docs_dir}")
+    if not _flowmark_available():
+        logger.warning(
+            "flowmark not on PATH; install the [flowmark] extra "
+            "(`uv pip install vexy-mkdocs-tools[flowmark]`) to enable this step"
+        )
+        return
+    cmd = [
+        "flowmark",
+        "--inplace",
+        "--nobackup",
+        "--semantic",
+        "--cleanups",
+        "--smartquotes",
+        "--ellipses",
+        "--width",
+        "0",
+        str(src_docs_dir),
+    ]
+    _run(cmd, root)
+    logger.info("Formatted source Markdown with Flowmark")
+
+
+class CLI:
+    """vexy-mkdocs-tools build orchestrator."""
+
+    def __init__(
+        self,
+        root: str | None = None,
+        config: str | None = None,
+        docs: str | None = None,
+        src: str | None = None,
+    ) -> None:
+        self._root = Path(root).resolve() if root else _find_repo_root()
+        self._config = (
+            Path(config).resolve() if config else self._root / "mkdocs" / "mkdocs.yml"
+        )
+        self._docs_dir = Path(docs).resolve() if docs else self._root / "docs"
+        self._src_docs_dir = Path(src).resolve() if src else self._root / "src_docs" / "md"
+
+    def clean(self, verbose: bool = False) -> None:
+        """Remove everything in docs/ except CNAME."""
+        _configure_logging(verbose)
+        try:
+            _clean_docs(self._docs_dir)
+        except BuildError as exc:
+            logger.error(str(exc))
+            sys.exit(1)
+
+    def format(self, verbose: bool = False) -> None:
+        """Format src_docs/md/ in place via Flowmark."""
+        _configure_logging(verbose)
+        try:
+            _format_with_flowmark(self._src_docs_dir, self._root)
+        except (BuildError, subprocess.CalledProcessError) as exc:
+            logger.error(str(exc))
+            sys.exit(1)
+
+    def build(self, verbose: bool = False, no_format: bool = False) -> None:
+        """Run full pipeline: format → clean → properdocs build → write .nojekyll."""
+        _configure_logging(verbose)
+        try:
+            if not no_format:
+                _format_with_flowmark(self._src_docs_dir, self._root)
+            _clean_docs(self._docs_dir)
+            if not self._config.is_file():
+                raise BuildError(f"mkdocs config missing: {self._config}")
+            _run(
+                [
+                    "properdocs",
+                    "build",
+                    "-f",
+                    str(self._config),
+                    "-d",
+                    str(self._docs_dir),
+                ],
+                self._root,
+            )
+            (self._docs_dir / ".nojekyll").touch()
+            logger.info("Build complete")
+        except BuildError as exc:
+            logger.error(str(exc))
+            sys.exit(1)
+        except subprocess.CalledProcessError as exc:
+            logger.error(f"build failed (exit {exc.returncode})")
+            sys.exit(1)
+
+    def serve(self, verbose: bool = False) -> None:
+        """Live-reload preview via properdocs serve."""
+        _configure_logging(verbose)
+        try:
+            if not self._config.is_file():
+                raise BuildError(f"mkdocs config missing: {self._config}")
+            _run(["properdocs", "serve", "-f", str(self._config)], self._root)
+        except BuildError as exc:
+            logger.error(str(exc))
+            sys.exit(1)
+        except subprocess.CalledProcessError as exc:
+            logger.error(f"properdocs serve failed (exit {exc.returncode})")
+            sys.exit(1)
+        except KeyboardInterrupt:
+            logger.info("Server stopped")
+
+    def version(self) -> None:
+        """Print the installed package version."""
+        from vexy_mkdocs_tools import __version__
+
+        print(__version__)
+
+
+def main() -> None:
+    """Console-script entry point for `vexy-mkdocs-tools` and `vmt`."""
+    fire.Fire(CLI)
+
+
+if __name__ == "__main__":
+    main()

vexy_mkdocs_tools-0.1.0/tests/test_cli.py

@@ -0,0 +1,52 @@
+# this_file: tests/test_cli.py
+"""Smoke tests for vexy_mkdocs_tools.cli."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+
+from vexy_mkdocs_tools.cli import (
+    BuildError,
+    _clean_docs,
+    _find_repo_root,
+)
+
+
+def test_clean_docs_creates_missing(tmp_path: Path) -> None:
+    target = tmp_path / "docs"
+    _clean_docs(target)
+    assert target.is_dir()
+
+
+def test_clean_docs_preserves_cname(tmp_path: Path) -> None:
+    docs = tmp_path / "docs"
+    docs.mkdir()
+    (docs / "CNAME").write_text("example.com\n", encoding="utf-8")
+    (docs / "index.html").write_text("<html></html>", encoding="utf-8")
+    nested = docs / "assets"
+    nested.mkdir()
+    (nested / "x.png").write_bytes(b"\x89PNG")
+
+    _clean_docs(docs)
+
+    assert (docs / "CNAME").read_text(encoding="utf-8") == "example.com\n"
+    assert not (docs / "index.html").exists()
+    assert not nested.exists()
+
+
+def test_find_repo_root_walks_up(tmp_path: Path) -> None:
+    root = tmp_path / "site"
+    (root / "mkdocs").mkdir(parents=True)
+    (root / "mkdocs" / "mkdocs.yml").write_text("site_name: x\n", encoding="utf-8")
+    (root / "src_docs").mkdir()
+    deep = root / "a" / "b" / "c"
+    deep.mkdir(parents=True)
+
+    assert _find_repo_root(start=deep) == root.resolve()
+
+
+def test_find_repo_root_raises_when_missing(tmp_path: Path) -> None:
+    with pytest.raises(BuildError, match="cannot locate site root"):
+        _find_repo_root(start=tmp_path)