#diagram #timing #digital #signal #svg #graphics

bin+lib mdbook-wavedrom-rs

MdBook 预处理器,用于 WaveDrom 数字时序图

1 个不稳定版本

0.1.0 2023 年 6 月 18 日

#59#digital

MPL-2.0 许可证

220KB
5K SLoC

MdBook-WaveDrom

wavedrom-rs 的集成,与 mdbook

入门指南

首先,使用 Rust 工具链 安装预处理器。

cargo install mdbook-wavedrom-rs

然后,将预处理器添加到 mdbook 配置文件 book.toml 中的预处理程序列表。

# book.toml

[preprocessor.wavedrom]

之后,您应该能够添加一个 wavedrom 代码块,在构建 mdbook 时将自动替换为 wavedrom-rs 图表。

# Chapter 1

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

添加皮肤

通过在 skin 属性中添加皮肤文件的路径,可以添加 WaveDrom 皮肤。

# book.toml

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

依赖项

~12–23MB
~326K SLoC