{"id":15023094,"url":"https://github.com/mikhailkravets/mkdocs_puml","last_synced_at":"2025-10-24T19:10:16.650Z","repository":{"id":59387950,"uuid":"535359855","full_name":"MikhailKravets/mkdocs_puml","owner":"MikhailKravets","description":"Inline PlantUML diagrams in your MkDocs documentation","archived":false,"fork":false,"pushed_at":"2024-10-25T11:23:21.000Z","size":5343,"stargazers_count":47,"open_issues_count":8,"forks_count":12,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-05T06:01:52.068Z","etag":null,"topics":["diagrams","documentation","inline","mkdocs","plantuml"],"latest_commit_sha":null,"homepage":"https://mikhailkravets.github.io/mkdocs_puml/","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/MikhailKravets.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":"2022-09-11T16:37:25.000Z","updated_at":"2025-03-28T07:20:39.000Z","dependencies_parsed_at":"2024-12-23T10:37:28.947Z","dependency_job_id":null,"html_url":"https://github.com/MikhailKravets/mkdocs_puml","commit_stats":{"total_commits":350,"total_committers":6,"mean_commits":"58.333333333333336","dds":0.04571428571428571,"last_synced_commit":"4d5942b4818c29eeb1bbc91a665805fb5f294d47"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikhailKravets%2Fmkdocs_puml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikhailKravets%2Fmkdocs_puml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikhailKravets%2Fmkdocs_puml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikhailKravets%2Fmkdocs_puml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikhailKravets","download_url":"https://codeload.github.com/MikhailKravets/mkdocs_puml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294514,"owners_count":20915340,"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":["diagrams","documentation","inline","mkdocs","plantuml"],"created_at":"2024-09-24T19:58:43.945Z","updated_at":"2025-10-24T19:10:16.563Z","avatar_url":"https://github.com/MikhailKravets.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](https://mikhailkravets.github.io/mkdocs_puml/assets/logos/logo.svg)\n\n\u003ch3 align=\"center\"\u003e\n\n\u003ca href=\"https://pypi.org/project/mkdocs_puml/\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/pypi/v/mkdocs-puml?style=for-the-badge\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://pypistats.org/packages/mkdocs-puml\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/pypi/dm/mkdocs_puml?style=for-the-badge\" /\u003e\u003c/a\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://mikhailkravets.github.io/mkdocs_puml/\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Documentation-gray?style=for-the-badge\u0026color=9D3058\"\u003e\u003c/a\u003e\n\u003ca href=\"https://mikhailkravets.github.io/mkdocs_puml/themes/\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/Themes%20Hub-449C90?style=for-the-badge\u0026\" /\u003e\u003c/a\u003e\n\n\u003c/h3\u003e\n\n`mkdocs_puml` is a fast and simple package that brings plantuml diagrams to MkDocs\ndocumentation.\n\n## Quick Start\n\nRun the following command to install the package\n\n```shell\npip install mkdocs_puml\n```\n\nAfter that, add `plantuml` plugin into `plugins` section of your `mkdocs.yml` file,\nin order to use PlantUML with MkDocs.\n\n```yaml\nplugins:\n  - plantuml:\n      puml_url: https://www.plantuml.com/plantuml/\n```\n\nNot include PlantUML code fences with `puml` keyword to your documentation, such as\n\n~~~\n```puml\n@startuml\nBob -\u003e Alice : hello\n@enduml\n```\n~~~\n\nThat's it, `mkdocs_puml` will automatically build `SVG` diagrams from the code 🎉\n\nFor more information, please refer to the [**documentation**](https://mikhailkravets.github.io/mkdocs_puml/).\n\n## License\n\nThis project is licensed under MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikhailkravets%2Fmkdocs_puml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikhailkravets%2Fmkdocs_puml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikhailkravets%2Fmkdocs_puml/lists"}