simple-mermaid

简单Mermaid图表RustDoc集成

此crate提供了一种简单的声明式宏，用于在rustdoc文档中包含mermaid图表。查看mermaid文档以获取图表语法的详细信息。

用法

1. 在自己的文件中创建mermaid图表（通常使用.mmd或.mermaid扩展名）。
2. 在#[doc]属性中调用[mermaid!]宏。将图表文件的路径指定为字符串字面量。注意，路径是相对于调用宏的文件来解释的，就像底层的include_str一样。
3. 完成！

替代方案

aquamarine

aquamarine引入了一个过程宏，可以将使用mermaid语言标记的常规代码块转换为过程宏。它还允许从外部文件包含图表，但这有一些限制

• 单个文档块中只能添加一个外部图表。
• 外部图表将始终出现在文档块的末尾。

这些限制使得aquamarine对我来说不是一个选择，因为我强烈倾向于将图表保留在外部文件中，原因有几点：杂乱、可维护性、IDE支持以及图表的可重用性。

此外，此crate中使用的声明式宏在编译时间上应该更容易。而且它没有任何依赖！

rsdoc

rsdoc crate 提供了过程宏，可以将 PlantUML 和图片嵌入文档注释中。它可以与代码块（类似于 aquamarine）或外部文件（类似于此 crate）一起使用。因此，在这种情况下，对我来说这只是一种个人喜好，PlantUML 和 mermaid 都是出色的开源项目。但 PlantUML 是 Java... 而我的植物总是死亡（即使是曾经有一只仙人掌！仙人掌怎么会死？这东西不应该需要水！）。

免责声明

此 crate 及其作者与 mermaid 项目没有任何关系或隶属关系，除了作为该强大库的用户。

本文档中的所有示例均已从 mermaid 文档 中提取，或进行了一些修改。

许可证：MIT