mkdocs-puml-file

Name	mkdocs-puml-file JSON
Version	1.0.1 JSON
	download
home_page	https://github.com/TomMeHo/mkdocs_puml_file
Summary	A MkDocs plugin that allows to embed PlantUML files.
upload_time	2025-01-27 08:58:41
maintainer	None
docs_url	None
author	Thomas Meder
requires_python	None
license	MIT
keywords	mkdocs plantuml publishing documentation uml sequence diagram
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs_puml_file

A MkDocs Plugin for embedding PlantUML files.

## Features

This plugin enables you to embed PlantUML diagrams in your documentation. Simple add your files like you would for any other image type:

```
![description](my-file.puml)
```

## Prerequisites

1. Install mkdocs_puml_file via ```pip install mkdocs_puml_file```.
1. For rendering, assure plugin ```mkdocs_plantuml``` is installed via ```pip``` as well.
1. Add plugin ```puml_file```before the entry of plugin ```plantuml``` in ```mkdocs.yml```. This is important, because MkDocs executes plugin events in the order of the plugins occurence in the configuration.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/TomMeHo/mkdocs_puml_file",
    "name": "mkdocs-puml-file",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "mkdocs plantuml publishing documentation uml sequence diagram",
    "author": "Thomas Meder",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/4c/38/21cb6e53bfca769d3e9888e1fb107ff4deeb666ccb566d9ca3a8d3059e21/mkdocs_puml_file-1.0.1.tar.gz",
    "platform": null,
    "description": "# mkdocs_puml_file\n\nA MkDocs Plugin for embedding PlantUML files.\n\n## Features\n\nThis plugin enables you to embed PlantUML diagrams in your documentation. Simple add your files like you would for any other image type:\n\n```\n![description](my-file.puml)\n```\n\n## Prerequisites\n\n1. Install mkdocs_puml_file via ```pip install mkdocs_puml_file```.\n1. For rendering, assure plugin ```mkdocs_plantuml``` is installed via ```pip``` as well.\n1. Add plugin ```puml_file```before the entry of plugin ```plantuml``` in ```mkdocs.yml```. This is important, because MkDocs executes plugin events in the order of the plugins occurence in the configuration.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A MkDocs plugin that allows to embed PlantUML files.",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/TomMeHo/mkdocs_puml_file"
    },
    "split_keywords": [
        "mkdocs",
        "plantuml",
        "publishing",
        "documentation",
        "uml",
        "sequence",
        "diagram"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a11ee04199822764bd8bf9e6b36a9a4a147cd01d8778038ab78e8646d8b0017d",
                "md5": "050ea95b78b4f1b036be1943ed6a96a2",
                "sha256": "8737a01a4d3a1ebe32be5a2034102e6a254d84777c2703fa9749c2aa79c6e5e0"
            },
            "downloads": -1,
            "filename": "mkdocs_puml_file-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "050ea95b78b4f1b036be1943ed6a96a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3948,
            "upload_time": "2025-01-27T08:58:40",
            "upload_time_iso_8601": "2025-01-27T08:58:40.353344Z",
            "url": "https://files.pythonhosted.org/packages/a1/1e/e04199822764bd8bf9e6b36a9a4a147cd01d8778038ab78e8646d8b0017d/mkdocs_puml_file-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4c3821cb6e53bfca769d3e9888e1fb107ff4deeb666ccb566d9ca3a8d3059e21",
                "md5": "bb234236351f87f9132a3d5eed9cfc2a",
                "sha256": "14f0deacf7ac0d5266cede56c87186c035273491721a84e069452adbe4227532"
            },
            "downloads": -1,
            "filename": "mkdocs_puml_file-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "bb234236351f87f9132a3d5eed9cfc2a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3370,
            "upload_time": "2025-01-27T08:58:41",
            "upload_time_iso_8601": "2025-01-27T08:58:41.665837Z",
            "url": "https://files.pythonhosted.org/packages/4c/38/21cb6e53bfca769d3e9888e1fb107ff4deeb666ccb566d9ca3a8d3059e21/mkdocs_puml_file-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-27 08:58:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "TomMeHo",
    "github_project": "mkdocs_puml_file",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-puml-file"
}