Skip to main content

MkDocs plugin to convert Drawio files to SVG format

Project description

README.md

MkDocs Drawio Converter Plugin

A MkDocs plugin that automatically converts Drawio (.drawio) files to SVG format during the build process.

Installation

pip install mkdocs-drawio-converter

Requirements

  • Draw.io desktop app installed (for the CLI tool)
  • MkDocs

Configuration

Add the following to your mkdocs.yml:

plugins:
  - drawio-converter:
      drawio_executable: /path/to/drawio  # Path to drawio executable
      source_dir: docs                    # Directory containing .drawio files
      output_dir: svg                     # Directory for output SVG files

Usage

  1. Place your .drawio files in your docs directory
  2. Build your MkDocs site
  3. Reference the converted SVG files in your markdown:
![My Diagram](svg/diagram.svg)

Project details


Download files

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

Source Distribution

mkdocs_drawio_converter-1.0.2.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_drawio_converter-1.0.2-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_drawio_converter-1.0.2.tar.gz.

File metadata

  • Download URL: mkdocs_drawio_converter-1.0.2.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for mkdocs_drawio_converter-1.0.2.tar.gz
Algorithm Hash digest
SHA256 629a733e472ec5dec5c60c62a7f2c67338eff5eba1472f7f15b7a51888bf0296
MD5 7feaf0a926d670ffa2e86e3e8b58c0e9
BLAKE2b-256 88117ffda1db0c8851c6b386792ca386e111a259a0cd8f70d4b2ac2d0f5646d6

See more details on using hashes here.

File details

Details for the file mkdocs_drawio_converter-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_drawio_converter-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 43dc5320bf0cd5ad8501f4a1511137d336f1591eef5d357240fbff5af2ca25f8
MD5 bad141ef078863d5c911c384ac77cf42
BLAKE2b-256 53f5a17914f82181ba426a42a29ccae762a62f0b8dc1468369e2ef6512a36b55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page