svgbobdoc

此 crate 提供了一个过程宏，它使用 svgbob 将文档注释中的 ASCII 图表渲染为 SVG 图片。

需要 Rust 版本 1.54 或更高版本或等效的夜间构建。

用法

将以下行添加到 Cargo.toml。

[dependencies]
svgbobdoc = { version = "0.2", features = ["enable"] }

transform!

使用 svgbob 代码块编写 ASCII 图表，并用 #[doc = transform!(...)] 将文档注释包裹起来。

#[doc = svgbobdoc::transform!(
/// Some structure.
///
/// ```svgbob
///  .--------------------.
///  | Diagrams here      |
///  `--------------------'
/// ```
)]
pub struct TestStruct {}

有关完整示例，请参阅 example 目录。

提示

• 使用此宏会增加编译时间。可以使用 enable Cargo 功能来关闭转换和大多数依赖项的编译。

• 可以在代码块标题中提供一个链接标签来生成链接参考定义（[label]: data:...），例如 ~~~svgbob,[label]。

许可证：MIT/Apache-2.0