zensical-wavedrom-plugin 0.1.1

A Zensical extension for rendering WaveDrom diagrams in Markdown

Zensical WaveDrom Plugin

A Zensical extension for rendering WaveDrom diagrams in Markdown. Visit the demo site.

This is a port of the mkdocs-wavedrom-plugin (or, my maintained fork) for the Zensical static site generator.

Features

• Transform fenced code blocks with language wavedrom into WaveDrom script tags or embedded SVG
• Support for pymdownx.superfences custom fences
• Optional SVG embedding at build time (no JavaScript required)

Installation

pip install zensical-wavedrom-plugin

Configuration

Add to your zensical.toml:

Default mode (JavaScript rendering)

In default mode, WaveDrom code blocks are transformed into <script type="WaveDrom"> tags and the WaveDrom JavaScript library processes them on page load.

[project]
extra_javascript = [
  "https://cdnjs.cloudflare.com/ajax/libs/wavedrom/3.5.0/skins/default.js",
  "https://cdnjs.cloudflare.com/ajax/libs/wavedrom/3.5.0/wavedrom.min.js"
]
[project.markdown_extensions.fenced_code]
[project.markdown_extensions.wavedrom]

Embed SVG mode

When embed_svg = true is set, WaveDrom diagrams are rendered to SVG at build time. This means no JavaScript is required on the client side.

[project.markdown_extensions.fenced_code]
[project.markdown_extensions.wavedrom]
embed_svg = true

Pymdownx Integration

This plugin integrates with pymdownx.superfences to provide custom fence support when pymdownx is used instead of fenced_code.

[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
  { name = "wavedrom", class = "wavedrom", format = "zensical_wavedrom_plugin.extension.fence_wavedrom_format" }
]
[project.markdown_extensions.wavedrom]

Usage

In your Markdown files:

```wavedrom
{ signal: [
  { name: "clk",  wave: "p....." },
  { name: "data", wave: "x.345x" }
] }
```

License

This project is licensed under the MIT License.