README.md

MkDocs Plugin for embedding Diagrams.net (Draw.io)

Buy me a 🍜

Features

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

![](my-diagram.drawio)

Additionally this plugin supports multi page diagrams by using the alt text:

![Page-2](my-diagram.drawio)

Setup

Install plugin using pip:

pip install mkdocs-drawio-file

Add the plugin to your mkdocs.yml

plugins:
  - drawio_file

Configuration

To use a custom instance of drawio you can overwritte the url.

plugins:
  - drawio_file:
      drawio_url: "https://your.local.instance"

How it works

After your mkdocs has generated the HTML for your documentation, the plugin adds the necessary diagram.net javascript library. Searches for img tags with a file ending of *.drawio and replaces them with the appropiate mxgraph html block. For further details, please look at the official diagrams.net documentation.