Skip to main content

Excalidraw drawings in mkdocs

Project description

Mkdocs Excalidraw

✨ A simple mkdocs plugin to easily embed your excalidraw drawings into your docs

See it in action here

Features

  • Embed your drawings as you would an image by converting your excalidraw drawings to svg on the fly
  • Dark mode compatibility for mkdocs and mkdocs-material themes

Installation

pip install mkdocs-excalidraw

Usage

You can use this project's docs as an example , lets break down how we do it.

  1. Create an excalidraw drawing and save the file (I recommend using the vscode extension)
  2. Add a reference to it in your markdown file as you would for an image
![fig_name](drawings/test.excalidraw)
  1. Thats it , the extension renders it as an svg in your browser

Issues

As you can see here are two issues with the current implementations:

  • The font is not correct
  • Text is not properly aligned

Both these issues have been noticed by excalidraw creators and should be fixed in the next release. I will update this plugin with the new version when it will come out.

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_excalidraw-0.3.2.tar.gz (7.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_excalidraw-0.3.2-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_excalidraw-0.3.2.tar.gz.

File metadata

  • Download URL: mkdocs_excalidraw-0.3.2.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.11 Linux/6.11.0-1018-azure

File hashes

Hashes for mkdocs_excalidraw-0.3.2.tar.gz
Algorithm Hash digest
SHA256 9a4c369ea01d74b59ebb0d7bed7a69a90c857bc224be5c657a539e441ccae685
MD5 ba97ce26dea9cbd62852bde154e073cd
BLAKE2b-256 19b64d454e41b7183615c33d027e2b5ef3122c2de50153e4f7bc3ded3eba6c37

See more details on using hashes here.

File details

Details for the file mkdocs_excalidraw-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_excalidraw-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.12.11 Linux/6.11.0-1018-azure

File hashes

Hashes for mkdocs_excalidraw-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 470b4ba89f61095d8f41e9a47cc9a73f556262c67ccfb2500be7ccec552a4f8b
MD5 bccae73b0c9f3791b4fa00feaf28cb9a
BLAKE2b-256 5cdccbc0d27f40bf4ab3e00637aef4a9d5a2695a83f6097fd31164576cbb2801

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