#mdbook #bibliography #add #citation #reference #documentation #referencing

app mdbook-bibfile-referencing

为每个页面添加bibfile引用的mdBook预处理器

3个版本 (破坏性更新)

0.3.0 2022年12月11日
0.2.0 2022年6月20日
0.1.0 2021年7月30日

文本处理类别中排名972

LGPL-2.1

27KB
272 代码行

mdBook Bibfile Referencing

Build status crates.io

一个使用Pandoc将引用添加到每个章节的mdBook预处理器。

用法

在你的book.toml中只需指定

[preprocessor.bibliography]
command = "mdbook-bibfile-referencing bibliography.bib ieee.csl"

你必须包含参考文献的路径,然后是定义生成的引用样式的CSL(引用样式语言)文件路径(你可以在此下载预先制作的文件)。

在你书的每个Markdown源章节中,你可以使用以下格式的引用:[@key, PAGE_NUMBER] - 详细语法请参考Pandoc Citeproc 文档

安装

确保你已经安装了Pandoc.

cargo install mdbook-bibfile-referencing

在CI/CD中的使用

提供了一个docker镜像:ghcr.io/jacob-pro/mdbook-bibfile-referencing:latest,可以简化并加速在CI系统中构建mdbook。

jobs:
  deploy:
    runs-on: ubuntu-18.04
    container:
      image: ghcr.io/jacob-pro/mdbook-bibfile-referencing:latest
    steps:
      - uses: actions/checkout@v2
      - name: Build book
        run: mdbook build

依赖项

~12-23MB
~333K SLoC