mdbook-wavedrom

为 mdbook 添加 wavedrom 支持的预处理器。这是基于 mdbook-mermaid 开发的，基本上就是一个搜索/替换。

它将这个

```wavedrom
{signal: [
  {name: 'clk', wave: 'p.....|...'},
  {name: 'dat', wave: 'x.345x|=.x', data: ['head', 'body', 'tail', 'data']},
  {name: 'req', wave: '0.1..0|1.0'},
  {},
  {name: 'ack', wave: '1.....|01.'}
]}
```

转换成这个

在你的书中。（由 wavedrom Live Editor 提供

安装

如果你只想使用这个预处理器，请安装工具

cargo install mdbook-wavedrom

然后让 mdbook-wavedrom 添加所需的文件和配置

mdbook-mermaid install path/to/your/book

这将向你的 book.toml 添加以下配置

[preprocessor.mermaid]
command = "mdbook-wavedrom"

[output.html]
additional-js = ["wavedrom.min.js", "wavedrom-init.js"]

它将跳过任何不必要的更改，并检测是否已配置 mdbook-mermaid。

此外，它将文件 mermaid.min.js 和 mermaid-init.js 复制到你的书籍目录中。您可以在 src/bin/assets 目录中找到这些文件。您可以通过修改 mermaid-init.js 来配置 Mermaid，有关所有选项，请参阅 Mermaid 文档。

最后，构建你的书籍

mdbook path/to/book

许可证

MPL。请参阅 LICENSE。
版权（c）2018-2021 Jan-Erik Rediger [email protected]

Mermaid 是 MIT 许可。捆绑的资产（mermaid.min.js）是 MIT 许可。