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.1.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.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_drawio_converter-1.0.1.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.1.tar.gz
Algorithm Hash digest
SHA256 a212058956a33e12cff1e9b38d151a19f21b968230eeb193bce90edf8b90753c
MD5 3abbff9809aab2cebe9cd0860b9712c3
BLAKE2b-256 af3fc79473cc15a6f31878d94d213c9c34fde35e8adfd0c279a481cd5d07c66e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_drawio_converter-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 28db47c92b0e67f3b5b308a16ad4dbbc5154c4f2d2f1feb2b1c560181ce532bc
MD5 df354677d82a624dc2c7ed380720a78d
BLAKE2b-256 7356c2e6de63c9663172f4e7684e050ecc4058785f14b5c5c5e0c5e7c4b964cb

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