yarner-block-links

A Yarner plugin that adds to each code block a list of links to all referenced and all referencing blocks.

Example:

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

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

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

Installation

Binaries

1. Download the latest binaries for your platform
2. Unzip somewhere
3. Add the parent directory of the executable to your PATH environmental variable

Using cargo

> cargo install yarner-block-links

Usage

Add a section plugin.block-links to your Yarner.toml:

[plugin.block-links]

Options

The plugin provides optional configuration for link formatting. Defaults are as follows (but all options can be left out):

[plugin.block-links]
template = "{{#if usage}}> Usage: {{usage}}  \n{{/if}}{{#if macros}}> Macros: {{macros}}{{/if}}"
join = " "
label = "`{{label}}`"