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.0.tar.gz (4.0 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.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_drawio_converter-1.0.0.tar.gz
  • Upload date:
  • Size: 4.0 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.0.tar.gz
Algorithm Hash digest
SHA256 56451f6784d044bcd269e75e0b5344de5b07b72a527931d3747d7446fa14c943
MD5 187569953fd22116744fc80027f4a171
BLAKE2b-256 95a9bb9bca0abf108307cdb7fe2d185b00006cdfe0df4d7dcabf7ab6cad64523

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_drawio_converter-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b78df68723faa49abc68ff5a1040db1c20114b8e5123c604f489388a1f248926
MD5 7d37f352b16a58761a9152be48defc8a
BLAKE2b-256 a143e31e406d893b48a743a0a8f03dd0050d531fe46c7a7f9916de50e37085af

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