Project Links

Meta

Author: Michał Wieluński

Requires Python: >=3.9

Classifiers

Development Status

5 - Production/Stable

Intended Audience

Developers
Information Technology
Science/Research

License

OSI Approved :: MIT License

Programming Language

Python
Python :: 3 :: Only
Python :: 3.9
Python :: 3.10
Python :: 3.11
Python :: 3.12

mkdocs-d2-plugin

A plugin for embedding D2 diagrams in MkDocs.

Documentation and live demo can be found here.

Requirements

Python >= 3.9
MkDocs >= 1.6.0
D2 >= 0.6.3

Installation

Install the plugin using pip:

pip install mkdocs-d2-plugin

And add it to your mkdocs.yml:

plugins:
  - d2

Usage

Fenced code block

```d2
shape: sequence_diagram
Alice -> John: Hello John, how are you?
Alice -> John.ack: John, can you hear me?
John.ack -> Alice: Hi Alice, I can hear you!
John -> Alice: I feel great!
```

Image tag

![Diagram](diagram.d2)

Demo app

You can find demo app in the docs directory. Live version is available here.

To run in locally:

cd docs
python3 -m venv .venv
source .venv/bin/activate
pip install mkdocs-material mkdocs-d2-plugin
mkdocs serve

To run it using Docker:

cd docs
docker build --tag mkdocs-d2-plugin:latest .
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-d2-plugin:latest

Wheel compatibility matrix

Platform	Python 3
any

Files in release

mkdocs_d2_plugin-1.6.0-py3-none-any.whl (8.3KiB)

mkdocs_d2_plugin-1.6.0.tar.gz (7.9KiB)

Extras: None

Dependencies:

mkdocs (>=1.6.0)

pymdown-extensions (>=9.0)

pydantic (>=2.0)

packaging

mkdocs-d2-plugin 1.6.0