Metadata-Version: 2.4
Name: mkdocs-excalidraw
Version: 0.4.0
Summary: Excalidraw drawings in mkdocs
License-File: LICENSE
Author: qdeli
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: beautifulsoup4 (>=4.13.5,<5.0.0)
Requires-Dist: mkdocs (>=1.6.1,<2.0.0)
Project-URL: Homepage, https://github.com/qdeli187/mkdocs-excalidraw
Project-URL: Issues, https://github.com/qdeli187/mkdocs-excalidraw/issues
Description-Content-Type: text/markdown

# Mkdocs Excalidraw

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

**See it in action [here](https://qdeli187.github.io/mkdocs-excalidraw/)**

## 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
```bash
pip install mkdocs-excalidraw
```

## Usage
You can use this project's [docs](https://qdeli187.github.io/mkdocs-excalidraw/) 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
```markdown
![fig_name](drawings/test.excalidraw)
```
3. Thats it , the extension renders it as an svg in your browser

