mkdocs-d2-plugin 0.1.0

MkDocs plugin for D2

mkdocs-d2-plugin

A plugin for the MkDocs documentation site generator which automatically generates and embeds D2 diagrams.

Requirements

• MkDocs >= 1.4.0
• D2

Installation

Install the plugin using pip:

pip install mkdocs-d2-plugin

And add it to your mkdocs.yml:

plugins:
  - d2

Usage

The plugin will automatically generate and embed D2 diagrams from code blocks with the d2 language tag.

Example

```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!
```

Configuration

The plugin can be configured globally in your mkdocs.yml file.

plugins:
  - d2:
      theme: 1
      sketch: False
      pad: 100
      scale: -1.0

Or locally in a code block.

```d2 theme=1 sketch=true pad=100 scale=-1.0
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!
```

List of available themes