mkdocs-bibtex

一个用于使用bibtex进行引文管理的MkDocs插件。

设置

使用pip安装插件

pip install mkdocs-bibtex

注意： 此插件需要在您的系统上安装pandoc。
如果您在使用pandoc时遇到问题，请尝试安装conda-forge版本的pypandoc： conda install -c conda-forge pypandoc，这将安装一个包含内置pandoc二进制的版本

接下来，将以下行添加到您的mkdocs.yml

plugins:
  - search
  - bibtex:
      bib_file: "refs.bib"
markdown_extensions:
  - footnotes

目前，脚注扩展是引文链接的方式。

如果您配置文件中还没有plugins条目，您可能还需要添加search插件。如果未设置plugins条目，MkDocs默认启用它。

选项

• bib_file - 单个bibtex文件的路径或url。路径可以是绝对路径，也可以是相对于mkdocs.yml的相对路径。示例URL： https://api.zotero.org/*/items?format=bibtex
• bib_dir - 要加载的bibtex文件的目录，路径解析方式与上述相同
• bib_command - 渲染参考文献的语法，默认为\bibliography
• bib_by_default - 自动将bib_command追加到每个Markdown文档的末尾，默认为true
• full_bib_command - 渲染整个参考文献的语法，默认为\full_bibliography
• csl_file - 指定 BibTeX CSL 文件的路径或 URL，用于指定您的引用格式。默认为 None，以纯格式显示。引用样式的注册表可在此处找到：https://github.com/citation-style-language/styles
• cite_inline - 是否在行内显示引用，需要指定 csl_file。默认为 False。

使用方法

在您的 Markdown 文件中

1. 按照您使用 pandoc 时的方式添加引用，例如：[@first_cite;@second_cite]
2. 将 \bibliography 或 bib_command 的值添加到您希望显示引用的文档中（如果 bib_by_default 设置为 true，则自动应用于每一页）。
3. （可选）将 \full_bibliography 或 full_bib_command 的值添加到您希望显示完整引用的地方。注意：由于此插件无法指定文件处理的顺序，当前此功能尚不能正常工作。确保包含完整引用的文件最后处理的最佳方法是使用数字作为文件/文件夹名的前缀以强制处理顺序，例如：01_my_first_file.md
4. （可选）配置 csl_file 选项以指定引用文本的格式。