#literate-programming #markdown #plugin

app yarner-block-links

一个为每个代码块添加所有引用和所有引用块的链接列表的Yarner插件。

2 个版本

0.1.2 2021年3月9日
0.1.1 2021年3月4日

#1406 in 文本处理

MIT 许可证

11KB
188

yarner-block-links

Test status GitHub Crate MIT license

一个向每个代码块添加所有引用和所有引用块的链接列表的Yarner插件。

示例

在引用其他块的每个代码块下方放置链接列表

//- Main block
fn main() {
    // ==> Block A.
    // ==> Block B.
}

宏: 块A 块B

被其他块引用的块将添加使用列表。

第一个引用的块

//- Block A
print!("Hello");

使用: 主块

第二个引用的块

//- Block B
println!(" World!");

使用: 主块

安装

二进制文件

  1. 下载您平台的最新二进制文件:最新二进制文件
  2. 解压缩到某处
  3. 将可执行文件父目录添加到您的PATH环境变量

使用 cargo

> cargo install yarner-block-links

用法

plugin.block-links部分添加到您的Yarner.toml

[plugin.block-links]

选项

插件提供了用于链接格式化的可选配置。默认值如下(但所有选项都可以省略)

[plugin.block-links]
template = "{{#if usage}}> Usage: {{usage}}  \n{{/if}}{{#if macros}}> Macros: {{macros}}{{/if}}"
join = " "
label = "`{{label}}`"
选项 详情
template 用于格式化链接部分的模板
join 链接之间的分隔符
label 链接标签的格式化

依赖关系

~6–8.5MB
~155K SLoC