Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mkdocs-drawio-file

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mkdocs-drawio-file

Mkdocs plugin that renders .drawio files

  • 1.5.2
  • PyPI
  • Socket score

Maintainers
1

MkDocs Plugin for embedding Diagrams.net (Draw.io)

PyPI

Buy me a 🍜

Features

This plugin enables you to embed interactive drawio diagrams in your documentation. Simple add your files like you would for any other image type:

![](my-diagram.drawio)

Additionally this plugin supports multi page diagrams by using the alt text:

![Page-2](my-diagram.drawio)

Setup

Install plugin using pip:

pip install mkdocs-drawio-file

Add the plugin to your mkdocs.yml

plugins:
  - drawio_file

How it works

After your mkdocs has generated the HTML for your documentation, the plugin adds the necessary diagram.net javascript library. Searches for img tags with a file ending of *.drawio and replaces them with the appropiate mxgraph html block. For further details, please look at the official diagrams.net documentation.

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc