mkdocs-gitsvg 0.0.1

MkDocs plugin that renders gitsvg git-graph diagrams from fenced code blocks to inline SVG.

mkdocs-gitsvg

MkDocs plugin that renders gitsvg git-graph diagrams from fenced code blocks to inline SVG at build time.

Status: early development. The package scaffold and release pipeline are in place; diagram rendering is being built out.

Installation

pip install mkdocs-gitsvg

Usage

Enable the plugin in mkdocs.yml:

plugins:
  - gitsvg

Then draw a git graph in any page with a ```gitsvg fenced block whose body is a gitsvg JSONL op-stream:

```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.