https://github.com/rzk-lang/mkdocs-plugin-rzk

MkDocs plugin for rzk proof assistant (inserts diagram renders).
https://github.com/rzk-lang/mkdocs-plugin-rzk

mkdocs-plugin

Last synced: 4 months ago
JSON representation

MkDocs plugin for rzk proof assistant (inserts diagram renders).

• Host: GitHub
• URL: https://github.com/rzk-lang/mkdocs-plugin-rzk
• Owner: rzk-lang
• Created: 2023-06-25T11:23:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-02T14:37:56.000Z (over 1 year ago)
• Last Synced: 2025-02-26T09:16:31.331Z (4 months ago)
• Topics: mkdocs-plugin
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-plugin-rzk/
• Size: 25.4 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Rzk plugin for MkDocs

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-plugin-rzk)](https://pypi.org/project/mkdocs-plugin-rzk/)

This is a [MkDocs plugin](https://www.mkdocs.org/dev-guide/plugins) for rendering SVG diagrams for Literate Rzk Markdown files (any file ending in `.rzk.md` extension). To use it, simply install the latest version (`pip install mkdocs-plugin-rzk`) and add it to your `mkdocs.yml` config file:

```yaml

plugins:

  - rzk

```

## Configuration

The following config options are supported:

| Name               | Type   | Default | Description                                     |

| ------------------ | ------ | ------- | ----------------------------------------------- |

| path               | `str`  | `rzk`   | Path to the Rzk executable                      |

| render_svg         | `bool` | `True`  | Enable/disable rendering SVGs for definitions (currently only works for files without dependencies) |

| anchor_definitions | `bool` | `True`  | Turn names of definitions into links to themselves (useful for generating a link to a particular `#define` in the generated MkDocs) |

## Development

To test this plugin while developing locally, run `pip install --editable ` in the MkDocs project where this plugin is to be used. You will need to manually stop and rerun the MkDocs server on every update (hot reloading does not work).

## Packaging and Deployment

If you don't have them already, install the `build` and `twine` packages as such: `python3 -m pip install --upgrade build twine`.

Next, package your code by running `python3 -m build` to generate distribution archives (wheels) under the `dist` directory.

Lastly, run `twine upload dist/*` to upload the new version to PyPI.