Package: mkdocs-drawio-exporter
Diagrams.net (Draw.io) Exporter for MkDocsExports your Draw.io diagrams at build time for easier embedding into your documentation.Quick startFirst install the package:$ pip install mkdocs-drawio-exporterThen enable it:plugins:-drawio-exporterConfigurationFor the default configuration, just add the plugin to thepluginskey:plugins:-drawio-exporterYou can override the default configuration:plugins:-drawio-exporter:# Diagrams are cached to speed up site generation. The default path is# drawio-exporter, relative to the documentation directory.cache_dir:'drawio-exporter'# Path to the Draw.io executable:#   * drawio on Linux#   * draw.io on macOS#   * or draw.io.exe on Windows# We'll look for it on your system's PATH, then default installation# paths. If we can't find it we'll warn you.drawio_executable:null# Additional Draw.io CLI argsdrawio_args:[]# Output format (see draw.io --help | grep format)format:svg# Embed format#   * The default is to embed via the <img> tag, only rewriting the#     value of the src attribute.#   * Consider <object type="image/svg+xml" data="{img_src}"></object>#     to enable interactive elements (like hyperlinks) in SVGs.embed_format:'{img_open}{img_src}{img_close}'# Glob pattern for matching source filessources:'*.drawio'UsageWith the plugin configured, you can now proceed to embed images by simply embedding the*.drawiodiagram file as you would with any image file:![My alt text](my-diagram.drawio)If you're working with multi-page documents, append the index of the page as an anchor in the URL:![Page 1](my-diagram.drawio#0)The plugin will export the diagram to theformatspecified in your configuration and will rewrite the<img>tag in the generated page to match. To speed up your documentation rebuilds, the generated output will be placed intocache_dirand then copied to the desired destination. The cached images will only be updated if the source diagram's modification date is newer than the cached export. Thus, bear in mind caching works per file - with large multi-page documents a change to one page will rebuild all pages, which will be slower than separate files per page.Headless usageIn addition to the above, if you're running in a headless environment (e.g. in integration, or inside a Docker container), you may need to ensure a display server is running and that the necessary dependencies are installed.On Debian and Ubuntu, the following should install the dependencies:sudo apt install libasound2 xvfbTo run MkDocs with an automatically assigned X display, wrap the command as follows:xvfb-run -a mkdocs buildRunning without the sandboxIf you're seeing messages like the following it's likely that you're running MkDocs as root:[22:0418/231827.169035:FATAL:electron_main_delegate.cc(211)] Running as root without --no-sandbox is not supported. See https://crbug.com/638180.If possible, consider running MkDocs as a non-privileged user. Depending on the circumstances (e.g. running within an unprivileged container) it may be appropriate to disable the Chrome sandbox by adding the following option tomkdocs.yml:plugins:-drawio-exporter:drawio_args:---no-sandboxHackingTo get completion working in your editor, set up a virtual environment in the root of this repository and install MkDocs:$ pip3 install --user --upgrade setuptools twine wheel
$ python3 -m venv venv
$ . venv/bin/activate
$ pip install -r requirements.txtTo install the plugin onto a local MkDocs site in editable form:$ pip install --editable /path/to/mkdocs-drawio-exporterNote that you'll need to repeat this step if you make any changes to theentry_pointslisted insetup.py.Run the tests with the Pythonunittestmodule:$ python -m unittest mkdocsdrawioexporter.testsUpgrading dependenciesTo upgrade the dependencies, installpip-upgrader:. venv/bin/activatepip install -r requirements.dev.txtThen proceed to update the dependencies:pip-upgrade requirements.dev.txtReleasingBuild the distributable package:$ python3 setup.py sdist bdist_wheelPush it to the PyPI test instance:$ python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*Test it inside a virtual environment:$ pip install --index-url https://test.pypi.org/simple/ --no-deps mkdocs-drawio-exporterLet's go live:$ python3 -m twine upload dist/*