MdBook-WaveDrom

Integration for wavedrom-rs with mdbook.

Getting started

First, install the preprocessor utilizing the Rust Toolchain.

cargo install mdbook-wavedrom-rs

Then, add the preprocessor to the list of preprocessors in your mdbook configuration file book.toml.

# book.toml

[preprocessor.wavedrom]

Afterwards, you should be able to add a wavedrom codeblock, which should automatically get replaced by a wavedrom-rs diagram when building the mdbook.

# Chapter 1

```wavedrom
{
    signal: [
        { name: "clk", wave: "p......." },
        { name: "pulses", wave: "0..10.10" },
    ]
}
```

Add a skin

A WaveDrom skin can be added by adding a path to a skin file in the skin property.

# book.toml

[preprocessor.wavedrom]
skin = "path/to/skin.json5"