2个版本

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

#12 in #literate-programming

MIT 许可证

28KB
663 代码行数（不包括注释）

yarner-bib

一个用于使用BibTeX参考文献的Yarner插件。

示例

以下是一个包含引用和参考文献占位符的Markdown源代码

## Yarner-bib example

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

## References

[[_REFS_]]

经过Yarner和yarner-bib处理后的输出

Yarner-bib示例

Yarner是一个用于文献编程的命令行工具（Knuth 1984）。另一个著名的文献编程环境是RMarkdown（Baumer & Udwin 2015）。

参考文献

Baumer B, Udwin D (2015): R Markdown. WIREs Computational Statistics 7:3, 167-177.

Knuth DE (1984): Literate Programming. The Computer Journal 27:2, 97-111.

安装

二进制文件

下载您平台上的最新二进制文件 GitHub仓库
解压到某处
将可执行文件所在父目录添加到您的 PATH 环境变量中

使用 cargo

> cargo install yarner-bib

用法

在您的 Yarner.toml 中添加一个 plugin.bib 部分

[plugin.bib]
...

使用BibTeX引用键进行引用，前面加 @

For details, see @Doe2020.

为了生成参考文献列表，在每个文件中放置占位符，或在 refs-file 下给出的文件中放置

## References

[[_REFS_]]

选项

该插件允许使用不同的选项，这些选项都是可选的

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

选项	详细信息	默认值
`bibliography`	要使用的BibTeX文件。	`bibliography.bib`
`style`	引用样式。可以是 `author-year` 或 `numbered`。	`author-year`
`refs-file`	中央参考文献的Markdown文件。如果没有给出，则使用每个文件中的参考文献。	none
`placeholder`	用参考文献列表替换的占位符	`[[_REFS_]]`
`link-refs`	将引用链接到参考文献。	`true`
`render-key`	在每条参考文献前渲染引用键。	`true`

依赖项

~10MB
~208K SLoC