yarner-block-links-0.1.2 is not a library.
yarner-block-links
A Yarner plugin that adds to each code block a list of links to all referenced and all referencing blocks.
Example:
A list of links is placed under each code block that references other blocks:
//- Main block
Blocks that are referenced by other blocks get a list of usages added.
The first referenced block:
//- Block A
print!;
Usage:
Main block
The second referenced block:
//- Block B
println!;
Usage:
Main block
Installation
Binaries
- Download the latest binaries for your platform
- Unzip somewhere
- 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
:
[]
Options
The plugin provides optional configuration for link formatting. Defaults are as follows (but all options can be left out):
[]
= "{{#if usage}}> Usage: {{usage}} \n{{/if}}{{#if macros}}> Macros: {{macros}}{{/if}}"
= " "
= "`{{label}}`"
Option | Details |
---|---|
template |
Template for formatting of the links section(s) |
join |
Separator between links |
label |
Formatting of link labels |