#mdbook #mermaid #graph #add #book #js

bin+lib mdbook-mermaid

mdbook 预处理器以添加 mermaid 支持

31 个版本

0.13.0 2023 年 12 月 13 日
0.12.6 2022 年 12 月 19 日
0.12.2 2022 年 11 月 29 日
0.11.2 2022 年 7 月 29 日
0.2.2 2019 年 7 月 16 日

#723 in 文本处理

Download history 1068/week @ 2024-04-18 1329/week @ 2024-04-25 1187/week @ 2024-05-02 1292/week @ 2024-05-09 1105/week @ 2024-05-16 1384/week @ 2024-05-23 1580/week @ 2024-05-30 1946/week @ 2024-06-06 2147/week @ 2024-06-13 2074/week @ 2024-06-20 1852/week @ 2024-06-27 1624/week @ 2024-07-04 1533/week @ 2024-07-11 1494/week @ 2024-07-18 1888/week @ 2024-07-25 1510/week @ 2024-08-01

6,795 每月下载次数
用于 mdbook-dtmo

MPL-2.0 许可证

3MB
2K SLoC

JavaScript 1.5K SLoC // 0.0% comments Rust 483 SLoC

mdbook-mermaid

mdbook 添加 mermaid.js 支持的预处理器。

它将这个

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

转换成这个

Simple Graph

在你的书中。 (图形由 Mermaid Live Editor 提供)

安装

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

cargo install mdbook-mermaid

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

mdbook-mermaid install path/to/your/book

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

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

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

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

此外,它将文件 mermaid.min.jsmermaid-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 许可证。

依赖关系

~14–25MB
~368K SLoC