Metadata-Version: 2.2
Name: mkdocs_puml_file
Version: 1.0.3
Summary: A MkDocs plugin that allows to embed PlantUML files.
Home-page: https://github.com/TomMeHo/mkdocs_puml_file
Author: Thomas Meder
License: MIT
Keywords: mkdocs plantuml publishing documentation uml sequence diagram
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# 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.
