yarner-bib

A Yarner plugin for citations using a BibTeX bibliography.

Example:

Here is a Markdown source with citations and a placeholder for the references:

## Yarner-bib example

Yarner is a command line tool for Literate Programming (@Knuth1984).
Another famous Literate Programming environment is RMarkdown (@Baumer2015).

## References

[[_REFS_]]

After processing with Yarner and yarner-bib, it produces this output:

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-bib

Usage

Add a section plugin.bib to your Yarner.toml:

[plugin.bib]
...

Cite using the BibTeX citation key, prefixed with @:

For details, see @Doe2020.

To generate the reference list, place the placeholder in each file, or in the file given under refs-file:

## References

[[_REFS_]]

Options

The plugin allows for different options, which are all optional:

[plugin.bib]
bibliography = "bibliography.bib"
style = "author-year"
refs-file = "References.md"
placeholder = "[[_REFS_]]"
link-refs = true
render-key = true