Newer version available (3.4.2)

Released:

A PlantUML plugin for Markdown

Markdown extension for PlantUML and Nikola. Renders PlantUML files from Nikola. JSDoc plugin to use PlantUML inside javascript documentation. Simple tool to turn a swagger api spec into a uml class diagram. Convert OpenAPI specifications to PlantUML diagrams. Generate UML Diagrams for Given Swagger Definition. Use it with LyX. Pandoc filter for PlantUML code blocks. Contribute to timofurrer/pandoc-plantuml-filter development by creating an account on GitHub.

Project description

This plugin implements a block extension which can be used to specify a PlantUML diagram which will beconverted into an image and inserted in the document.

Syntax:

Example:

The GitLab/GitHub block syntax is also recognized. Example:

Options are optional (otherwise the wouldn't be options), but if present must be specified in the order format, classes, alt, title, width, height.The option value may be enclosed in single or double quotes.

Supported values for format parameter are:

png: HTML img tag with embedded png image
svg: HTML img tag with embedded svg image (links are not navigable)
svg_object: HTML object tag with embedded svg image (links are navigable)
svg_inline: HTML5 svg tag with inline svg image source (links are navigable, can be manipulated with CSS rules)
txt: plain text diagrams.

The width and height options must include a CSS unit.

Installation

There are two choises, use a local binary or use a remote service.

Using a local PlantUML binary

You need to install PlantUML (see the site for details) and Graphviz 2.26.3 or later.The plugin expects a program plantuml in the classpath. If not installed by your packagemanager, you can create a shell script and place it somewhere in the classpath. For example,save te following into /usr/local/bin/plantuml (supposing PlantUML installed into/opt/plantuml):

On Windows can be used the following plantuml.bat (many thanks to henn1001):

Make sure the plantuml.bat is on the path.

For Gentoo Linux there is an ebuild at http://gpo.zugaina.org/dev-util/plantuml/RDep: you can downloadthe ebuild and the files subfolder or you can add the zugaina repository with layman(recommended).

To use the plugin with Python-Markdown you have three choices:

do a simple pip install plantuml-markdown, and the plugin should be ready to be used
copy the file plantuml-markdown.py in the extensions folder of Python-Markdown. For example, for Python 2.7 you mustdo:
copy the file somewhere in your home. A good choice may be the user-site path, for example (bash syntax):
You must export PYTHONPATH before running markdown_py, or you can put the definition in ~/.bashrc.

After installed, you can use this plugin by activating it in the markdown_py command. For example:

Using a PlantUML server

From version 2.0 a PlantUML server can be used for rendering diagrams. This speedups alot the diagrams rendering but needs to send the diagram source to a server.

You can download the war and deploy in a servletcontainer, or you can run it as a docker container.

In either cases you need to specify the URL of the server in a configuration file like:

Then you need to specify the configuration file on the command line:

Running tests

The test execution requires a specific version of PlantUML (the image generated can be different with different PlantUML versions).

To run the tests, execute the following command:

This command uses a custom version of the plantuml command which will download the expected version of PlantUML fortests execution without clobbering the system.

Release historyRelease notifications | RSS feed

3.4.2

3.4.1

3.4.0

3.3.0

3.2.2

3.2.1

3.2.0

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.0

2.0.2

2.0.1

2.0.0

1.4.0

1.3.0

1.2.6

Plantuml Download

1.2.5

1.2.4

1.2.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for plantuml-markdown, version 2.0.1
Filename, size	File type	Python version	Upload date	Hashes
Filename, size plantuml_markdown-2.0.1-py2-none-any.whl (8.5 kB)	File type Wheel	Python version py2	Upload date	Hashes
Filename, size plantuml_markdown-2.0.1-py3-none-any.whl (7.6 kB)	File type Wheel	Python version py3	Upload date	Hashes

Close

Hashes for plantuml_markdown-2.0.1-py2-none-any.whl

Hashes for plantuml_markdown-2.0.1-py2-none-any.whl
Algorithm	Hash digest
SHA256	`14b235bdefcc069e95eaf34f84b48ab53e6f0fc6962f9e1278bca7916769118b`
MD5	`48ef58bda93fd7444ac45f2689e2c14c`
BLAKE2-256	`407a00022163e80f260c9dc62436fa312a8414f558611e461d270a901911d710`

Plantuml Markdown Vscode

Close

Hashes for plantuml_markdown-2.0.1-py3-none-any.whl

Hashes for plantuml_markdown-2.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`916e606a940d110e4b5c8efef854b5e98a45adc614fd9fd63817931d2b5ea33d`
MD5	`507eab6cc1961bc8dd53d77813cee217`
BLAKE2-256	`c7247db06aa7d85bac05d5a7b823a08768354d54d096c5cae0345040979020ec`

Preview and build your markdown files quickly in your web browser.

You can use the builtin Python Markdown parser (offline) or use the GitHub Markdown API (online) or GitLab Markdown API (online) for the conversion.

Note

Github Markdown Plantuml

If you choose the GitHub or GitLab API for conversion (set parser to github or gitlab in your settings), your code will be sent through HTTPS to GitHub or GitLab for live conversion. In case of GitHub, You'll have GitHub Flavored Markdown, syntax highlighting and EMOJI support for free . If you make more than 60 calls a day, be sure to set your GitHub API key in the settings .

Features

Markdown preview using the python-markdown with syntax highlighting via Pygments and optional 3^rd party extensions (pymdown-extensions included by default).
Markdown previews via the GitHub API.
Markdown previews via the GitLab API.
Ability use other external Markdown parsers.
Build markdown file using Sublime Text build system.
Browser preview auto reload on save if you have the LiveReload plugin installed.
Configurable CSS and JavaScript assets with overriding if needed.
YAML support thanks to @tommi.
Clipboard selection and copy to clipboard thanks to @hexatrope.
MathJax support : frac{pi}{2} thanks to @bps10.
HTML template customization thanks to @hozaka.
Embed images as base64.
Strip out MultiMarkdown CriticMarkup.

Support

Any bugs about Markdown Preview please feel free to report here.
And you are welcome to fork and submit pull requests.

Markdown Editor With Plantuml