mkdocs-gitsvg 0.0.1__tar.gz

mkdocs_gitsvg-0.0.1/.gitignore

@@ -0,0 +1,40 @@
+# Python
+__pycache__/
+*.egg-info/
+dist/
+.pytest_cache/
+.ruff_cache/
+
+# Coverage
+htmlcov/
+.coverage
+reports/
+
+# Virtual environments
+.venv/
+
+# Private dev docs
+design/
+.local/
+local/
+
+# IDE
+.idea/
+.vscode/
+
+# OS
+.DS_Store
+._*
+Thumbs.db
+Desktop.ini
+
+# AI assistants
+.claude/
+CLAUDE.md
+AGENTS.md
+.cursor/
+.cursorrules
+.aider*
+.copilot/
+.github/copilot-instructions.md
+.temp/

mkdocs_gitsvg-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Bert Pluymers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocs_gitsvg-0.0.1/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: mkdocs-gitsvg
+Version: 0.0.1
+Summary: MkDocs plugin that renders gitsvg git-graph diagrams from fenced code blocks to inline SVG.
+Project-URL: Source, https://github.com/bertpl/mkdocs-gitsvg
+Project-URL: Changelog, https://github.com/bertpl/mkdocs-gitsvg/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/bertpl/mkdocs-gitsvg/issues
+Author-email: Bert Pluymers <bert.pluymers@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: diagram,documentation,git,mkdocs,mkdocs-plugin,svg
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+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
+Requires-Python: >=3.11
+Requires-Dist: gitsvg
+Requires-Dist: mkdocs>=1.4
+Requires-Dist: pymdown-extensions>=10.0
+Description-Content-Type: text/markdown
+
+# mkdocs-gitsvg
+
+MkDocs plugin that renders [gitsvg](https://github.com/bertpl/gitsvg) git-graph
+diagrams from fenced code blocks to inline SVG at build time.
+
+[![CI](https://img.shields.io/github/actions/workflow/status/bertpl/mkdocs-gitsvg/push_to_main.yml?branch=main&label=CI)](https://github.com/bertpl/mkdocs-gitsvg/actions/workflows/push_to_main.yml)
+[![PyPI](https://img.shields.io/pypi/v/mkdocs-gitsvg.svg)](https://pypi.org/project/mkdocs-gitsvg/)
+[![Python](https://img.shields.io/pypi/pyversions/mkdocs-gitsvg.svg)](https://pypi.org/project/mkdocs-gitsvg/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/bertpl/mkdocs-gitsvg/blob/main/LICENSE)
+
+> **Status:** early development. The package scaffold and release pipeline are
+> in place; diagram rendering is being built out.
+
+## Installation
+
+```bash
+pip install mkdocs-gitsvg
+```
+
+## Usage
+
+Enable the plugin in `mkdocs.yml`:
+
+```yaml
+plugins:
+  - gitsvg
+```
+
+Then draw a git graph in any page with a ` ```gitsvg ` fenced block whose body
+is a [gitsvg](https://github.com/bertpl/gitsvg) JSONL op-stream:
+
+````markdown
+```gitsvg
+{"op": "branch", "name": "main", "label_side": "before"}
+{"op": "commit", "branch": "main", "id": "c1", "msg": "initial commit", "hash": "auto"}
+{"op": "commit", "branch": "main", "id": "c2", "msg": "add README", "hash": "auto"}
+```
+````
+
+The block renders to an inline SVG git graph in the built site.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

mkdocs_gitsvg-0.0.1/README.md

@@ -0,0 +1,44 @@
+# mkdocs-gitsvg
+
+MkDocs plugin that renders [gitsvg](https://github.com/bertpl/gitsvg) git-graph
+diagrams from fenced code blocks to inline SVG at build time.
+
+[![CI](https://img.shields.io/github/actions/workflow/status/bertpl/mkdocs-gitsvg/push_to_main.yml?branch=main&label=CI)](https://github.com/bertpl/mkdocs-gitsvg/actions/workflows/push_to_main.yml)
+[![PyPI](https://img.shields.io/pypi/v/mkdocs-gitsvg.svg)](https://pypi.org/project/mkdocs-gitsvg/)
+[![Python](https://img.shields.io/pypi/pyversions/mkdocs-gitsvg.svg)](https://pypi.org/project/mkdocs-gitsvg/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/bertpl/mkdocs-gitsvg/blob/main/LICENSE)
+
+> **Status:** early development. The package scaffold and release pipeline are
+> in place; diagram rendering is being built out.
+
+## Installation
+
+```bash
+pip install mkdocs-gitsvg
+```
+
+## Usage
+
+Enable the plugin in `mkdocs.yml`:
+
+```yaml
+plugins:
+  - gitsvg
+```
+
+Then draw a git graph in any page with a ` ```gitsvg ` fenced block whose body
+is a [gitsvg](https://github.com/bertpl/gitsvg) JSONL op-stream:
+
+````markdown
+```gitsvg
+{"op": "branch", "name": "main", "label_side": "before"}
+{"op": "commit", "branch": "main", "id": "c1", "msg": "initial commit", "hash": "auto"}
+{"op": "commit", "branch": "main", "id": "c2", "msg": "add README", "hash": "auto"}
+```
+````
+
+The block renders to an inline SVG git graph in the built site.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

mkdocs_gitsvg-0.0.1/mkdocs_gitsvg/__init__.py

@@ -0,0 +1,5 @@
+"""mkdocs-gitsvg — MkDocs plugin rendering gitsvg diagrams to inline SVG."""
+
+from importlib.metadata import version
+
+__version__ = version("mkdocs-gitsvg")

mkdocs_gitsvg-0.0.1/mkdocs_gitsvg/plugin.py

@@ -0,0 +1,13 @@
+"""The mkdocs-gitsvg MkDocs plugin.
+
+Scaffold placeholder: a no-op MkDocs ``BasePlugin`` subclass registered
+under the ``gitsvg`` plugin name (via the ``mkdocs.plugins`` entry
+point) so MkDocs discovers it. Fenced-block rendering, configuration,
+and styling are added in later layers.
+"""
+
+from mkdocs.plugins import BasePlugin
+
+
+class GitSvgPlugin(BasePlugin):
+    """No-op MkDocs plugin placeholder for mkdocs-gitsvg."""

mkdocs_gitsvg-0.0.1/pyproject.toml

@@ -0,0 +1,69 @@
+[project]
+name = "mkdocs-gitsvg"
+version = "0.0.1"
+description = "MkDocs plugin that renders gitsvg git-graph diagrams from fenced code blocks to inline SVG."
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "Bert Pluymers", email = "bert.pluymers@gmail.com" }
+]
+requires-python = ">=3.11"
+keywords = ["mkdocs", "mkdocs-plugin", "git", "svg", "diagram", "documentation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Documentation",
+]
+dependencies = [
+    "mkdocs>=1.4",
+    "gitsvg",
+    "pymdown-extensions>=10.0",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0",
+    "pytest-cov>=6.0",
+    "ruff>=0.14.0",
+    "pre-commit>=4.0",
+]
+
+[project.entry-points."mkdocs.plugins"]
+gitsvg = "mkdocs_gitsvg.plugin:GitSvgPlugin"
+
+[project.urls]
+Source = "https://github.com/bertpl/mkdocs-gitsvg"
+Changelog = "https://github.com/bertpl/mkdocs-gitsvg/blob/main/CHANGELOG.md"
+Issues = "https://github.com/bertpl/mkdocs-gitsvg/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+packages = ["mkdocs_gitsvg"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["mkdocs_gitsvg"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["I"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["mkdocs_gitsvg"]
+
+[tool.coverage.report]
+precision = 2