{"id":20814355,"url":"https://github.com/rzk-lang/mkdocs-plugin-rzk","last_synced_at":"2025-08-02T10:12:54.471Z","repository":{"id":179955698,"uuid":"658307369","full_name":"rzk-lang/mkdocs-plugin-rzk","owner":"rzk-lang","description":"MkDocs plugin for rzk proof assistant (inserts diagram renders).","archived":false,"fork":false,"pushed_at":"2023-11-02T14:37:56.000Z","size":26,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-19T20:36:35.674Z","etag":null,"topics":["mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/mkdocs-plugin-rzk/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rzk-lang.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-25T11:23:39.000Z","updated_at":"2025-07-06T09:22:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"185b21aa-e114-4219-817f-2d902fb33513","html_url":"https://github.com/rzk-lang/mkdocs-plugin-rzk","commit_stats":null,"previous_names":["rzk-lang/mkdocs-plugin-rzk"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/rzk-lang/mkdocs-plugin-rzk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzk-lang%2Fmkdocs-plugin-rzk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzk-lang%2Fmkdocs-plugin-rzk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzk-lang%2Fmkdocs-plugin-rzk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzk-lang%2Fmkdocs-plugin-rzk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rzk-lang","download_url":"https://codeload.github.com/rzk-lang/mkdocs-plugin-rzk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rzk-lang%2Fmkdocs-plugin-rzk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268370180,"owners_count":24239766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs-plugin"],"created_at":"2024-11-17T21:15:50.852Z","updated_at":"2025-08-02T10:12:54.438Z","avatar_url":"https://github.com/rzk-lang.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rzk plugin for MkDocs\n\n[![PyPI - Version](https://img.shields.io/pypi/v/mkdocs-plugin-rzk)](https://pypi.org/project/mkdocs-plugin-rzk/)\n\nThis 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:\n\n```yaml\nplugins:\n  - rzk\n```\n\n## Configuration\n\nThe following config options are supported:\n\n| Name               | Type   | Default | Description                                     |\n| ------------------ | ------ | ------- | ----------------------------------------------- |\n| path               | `str`  | `rzk`   | Path to the Rzk executable                      |\n| render_svg         | `bool` | `True`  | Enable/disable rendering SVGs for definitions (currently only works for files without dependencies) |\n| 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) |\n\n## Development\n\nTo test this plugin while developing locally, run `pip install --editable \u003cpath/to/this/folder\u003e` 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).\n\n## Packaging and Deployment\n\nIf you don't have them already, install the `build` and `twine` packages as such: `python3 -m pip install --upgrade build twine`.\n\nNext, package your code by running `python3 -m build` to generate distribution archives (wheels) under the `dist` directory.\n\nLastly, run `twine upload dist/*` to upload the new version to PyPI.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzk-lang%2Fmkdocs-plugin-rzk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frzk-lang%2Fmkdocs-plugin-rzk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frzk-lang%2Fmkdocs-plugin-rzk/lists"}