<h3 align="center">
<a href="https://pypi.org/project/mkdocs_puml/" target="_blank"><img src="https://img.shields.io/pypi/v/mkdocs-puml?style=for-the-badge" /></a>
<a href="https://pypistats.org/packages/mkdocs-puml" target="_blank"><img src="https://img.shields.io/pypi/dm/mkdocs_puml?style=for-the-badge" /></a>
<br />
<a href="https://mikhailkravets.github.io/mkdocs_puml/" target="_blank"><img src="https://img.shields.io/badge/Documentation-gray?style=for-the-badge&color=9D3058"></a>
<a href="https://mikhailkravets.github.io/mkdocs_puml/themes/" target="_blank"><img src="https://img.shields.io/badge/Themes%20Hub-449C90?style=for-the-badge&" /></a>
</h3>
`mkdocs_puml` is a fast and simple package that brings plantuml diagrams to MkDocs
documentation.
## Quick Start
Run the following command to install the package
```shell
pip install mkdocs_puml
```
After that, add `plantuml` plugin into `plugins` section of your `mkdocs.yml` file,
in order to use PlantUML with MkDocs.
```yaml
plugins:
- plantuml:
puml_url: https://www.plantuml.com/plantuml/
```
Not include PlantUML code fences with `puml` keyword to your documentation, such as
~~~
```puml
@startuml
Bob -> Alice : hello
@enduml
```
~~~
That's it, `mkdocs_puml` will automatically build `SVG` diagrams from the code 🎉
For more information, please refer to the [**documentation**](https://mikhailkravets.github.io/mkdocs_puml/).
## License
This project is licensed under MIT license.
Raw data
{
"_id": null,
"home_page": "https://github.com/MikhailKravets/mkdocs_puml",
"name": "mkdocs_puml",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "markdown, mkdocs, plantuml, puml, uml, documentation, diagram, uml-diagrams, plugin, mkdocs-plugin",
"author": "Mikhail Kravets",
"author_email": "michkravets@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4c/61/f742f25cb6c301bf283355bcf0e9db0e5d0c9217a7e5deb97f8684bf3097/mkdocs_puml-2.3.0.tar.gz",
"platform": null,
"description": "\n\n<h3 align=\"center\">\n\n<a href=\"https://pypi.org/project/mkdocs_puml/\" target=\"_blank\"><img src=\"https://img.shields.io/pypi/v/mkdocs-puml?style=for-the-badge\" /></a>\n<a href=\"https://pypistats.org/packages/mkdocs-puml\" target=\"_blank\"><img src=\"https://img.shields.io/pypi/dm/mkdocs_puml?style=for-the-badge\" /></a>\n<br />\n<a href=\"https://mikhailkravets.github.io/mkdocs_puml/\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Documentation-gray?style=for-the-badge&color=9D3058\"></a>\n<a href=\"https://mikhailkravets.github.io/mkdocs_puml/themes/\" target=\"_blank\"><img src=\"https://img.shields.io/badge/Themes%20Hub-449C90?style=for-the-badge&\" /></a>\n\n</h3>\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 -> Alice : hello\n@enduml\n```\n~~~\n\nThat's it, `mkdocs_puml` will automatically build `SVG` diagrams from the code \ud83c\udf89\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package that brings PlantUML to MkDocs",
"version": "2.3.0",
"project_urls": {
"Documentation": "https://mikhailkravets.github.io/mkdocs_puml/",
"Homepage": "https://github.com/MikhailKravets/mkdocs_puml",
"Repository": "https://github.com/MikhailKravets/mkdocs_puml"
},
"split_keywords": [
"markdown",
" mkdocs",
" plantuml",
" puml",
" uml",
" documentation",
" diagram",
" uml-diagrams",
" plugin",
" mkdocs-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "124f8db4743bbe04a9e2ee09cddacf2b7ffd5e214899a974481fb1481de44711",
"md5": "2e42864a8cf8a2bdecc6dc9a5b584bdd",
"sha256": "8fb6a3bceaa9d20020d274b5b6d8acd2f18b809511604c0d2fcb450ac3f3a160"
},
"downloads": -1,
"filename": "mkdocs_puml-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e42864a8cf8a2bdecc6dc9a5b584bdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 17313,
"upload_time": "2024-10-25T11:10:28",
"upload_time_iso_8601": "2024-10-25T11:10:28.124803Z",
"url": "https://files.pythonhosted.org/packages/12/4f/8db4743bbe04a9e2ee09cddacf2b7ffd5e214899a974481fb1481de44711/mkdocs_puml-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c61f742f25cb6c301bf283355bcf0e9db0e5d0c9217a7e5deb97f8684bf3097",
"md5": "43a817de5d09222df659a1766214fbc6",
"sha256": "51c7f742eb6384e4e48db880a638869dff9b39a7d42cc42d86aaf25f0ffdb5aa"
},
"downloads": -1,
"filename": "mkdocs_puml-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "43a817de5d09222df659a1766214fbc6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 14410,
"upload_time": "2024-10-25T11:10:29",
"upload_time_iso_8601": "2024-10-25T11:10:29.837399Z",
"url": "https://files.pythonhosted.org/packages/4c/61/f742f25cb6c301bf283355bcf0e9db0e5d0c9217a7e5deb97f8684bf3097/mkdocs_puml-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-25 11:10:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MikhailKravets",
"github_project": "mkdocs_puml",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mkdocs_puml"
}
JSON
