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.1.1.tar.gz (7.2 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.1.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_drawio_converter-1.1.1.tar.gz
  • Upload date:
  • Size: 7.2 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.1.1.tar.gz
Algorithm Hash digest
SHA256 1a7ca67f49cbbe722240f8ec8f5f30305453f03a4c6c525a9e5d76e4526c4993
MD5 1d6e15779a6437e6ca204326af3fc1ff
BLAKE2b-256 9f7e31f06a7c5a4d10708a498d527410960b1844b83d580e848926df3c974d52

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_drawio_converter-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 66c53134548fee5ae4cbbe49344d73c54b0ec8b0660aecd0f990cc40b20b8881
MD5 b0cd8ba0baea4c8b1bee75b64f71886b
BLAKE2b-256 86f33cad2197924d1de0aec5ec08fe42ebd104b03ade1f15d2b4304effc8db04

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