{"id":19931079,"url":"https://github.com/sphinx-contrib/kroki","last_synced_at":"2025-05-03T10:32:25.129Z","repository":{"id":46707149,"uuid":"289231214","full_name":"sphinx-contrib/kroki","owner":"sphinx-contrib","description":"Embed PlantUML, DOT, etc. diagrams in your documentation using Kroki.","archived":false,"fork":false,"pushed_at":"2024-05-30T15:48:19.000Z","size":46,"stargazers_count":43,"open_issues_count":17,"forks_count":15,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-07T15:01:32.301Z","etag":null,"topics":["diagram","dot","erd","graphviz","kroki","plantuml","sphinx-doc","sphinx-extension","svgbob","umlet"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-08-21T09:30:20.000Z","updated_at":"2025-03-30T15:47:16.000Z","dependencies_parsed_at":"2024-06-19T02:45:15.210Z","dependency_job_id":"ffc103fa-c6e8-4b0d-bf2b-72e0da8b67fe","html_url":"https://github.com/sphinx-contrib/kroki","commit_stats":{"total_commits":27,"total_committers":3,"mean_commits":9.0,"dds":0.07407407407407407,"last_synced_commit":"f0d75724039ec448e668ffab846904e47e7b3231"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fkroki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fkroki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fkroki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fkroki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/kroki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252179119,"owners_count":21707107,"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","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":["diagram","dot","erd","graphviz","kroki","plantuml","sphinx-doc","sphinx-extension","svgbob","umlet"],"created_at":"2024-11-12T23:06:01.317Z","updated_at":"2025-05-03T10:32:24.828Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"sphinxcontrib-kroki\n===================\n\nEmbed PlantUML, DOT, etc. diagrams in your Sphinx-based documentation using\n[kroki](https://kroki.io/).\n\nInstalation\n-----------\n\nInstall this package via pip:\n\n```shell script\npip install sphinxcontrib-kroki\n```\n\nand enable in project configuration (`conf.py`):\n\n```python\nextensions = [\n    'sphinxcontrib.kroki',\n]\n```\n\nUsage\n-----\n\nInline diagram, show as svg:\n\n```rest\n.. kroki::\n   :caption: Diagram\n\n    @startuml\n    Alice -\u003e Bob: Authentication Request\n    Bob --\u003e Alice: Authentication Response\n\n    Alice -\u003e Bob: Another authentication Request\n    Alice \u003c-- Bob: Another authentication Response\n    @enduml\n```\n\nLoad a diagram from a file and show as png:\n\n```rest\n.. kroki:: ./path/to/graph.puml png\n```\n\n### Options\n\n- `:align:` The horizontal alignment of the diagram (left, center or right);\n- `:caption:` The caption of the diagram;\n- `:class:` The class names (a list of class names separeted by spaces);\n- `:filename:` The path to the file with the diagram;\n- `:format:` The output format of the diagram (default svg);\n- `:name:` The hyperlink reference to the element;\n- `:options:`: The [diagram options](https://docs.kroki.io/kroki/setup/diagram-options/) in yaml format;\n- `:type:` The type of the diagram (actdiag, blockdiag, bpmn, bytefield,\n  c4plantuml, dot, ditaa, er, erd, excalidraw, graphviz, mermaid, nomnoml,\n  nwdiag, packetdiag, pikchr, plantuml, rackdiag, structurizr, seqdiag,\n  svgbob, umlet, vega, vegalite, wavedrom).\n\nThe diagram type can be automatically derived from the file extension (as same as `type`).\nAdditional supported extensions:\n\nExtension  | Type\n---------- | ----\n*.bob      | svgbob\n*.c4       | c4plantuml\n*.c4puml   | c4plantuml\n*.dot      | graphviz\n*.dsl      | structurizr\n*.er       | erd\n*.gv       | graphviz\n*.iuml     | plantuml\n*.pu       | plantuml\n*.puml     | plantuml\n*.uxf      | umlet\n*.vg       | vega\n*.vgl      | vegalite\n*.vl       | vegalite\n*.wsd      | plantuml\n\nConfiguration\n-------------\n\n- `kroki_url` (default https://kroki.io).\n- `kroki_output_format` (default svg).\n- `kroki_inline_svg` (dafault False).\n\nAlternatives\n------------\n\n- https://github.com/sphinx-contrib/plantuml\n- https://github.com/sphinx-contrib/gravizo\n- https://github.com/j-martin/sphinx-diagrams\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fkroki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fkroki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fkroki/lists"}