mdbook-bibtex

Adds support for bibliographies to mdbook. Backed by hayagriva, supporting all CSL citation styles.

Installation

cargo install mdbook-bibtex

Configuration

Add to your book.toml:

[preprocessor.bibtex]
# Supports both .bib and .yaml bibliographies
bibliography = "bibliography.bib"
# Heading for the bibliography section
title = "Bibliography"
# Either a CSL XML file path or one of the official citation style names
style = "ieee"
# Where to place the bibliography: "global" (new chapter at the end), 
# "chapter" (at the end of each chapter), or "footnotes" (as footnotes)
biblio_location = "global"
# If true, missing citation keys will cause the build to fail
error_on_missing_keys = true
# If true, citations will show a tooltip with the full reference
citation_preview = true
# If true, all bibliography entries will be included (even if not cited)
display_all = true

Usage

Cite sources using @@key where key is the citation identifier from your bibliography file.

Comparison to mdbook-bib

Initially, I planned to extend mdbook-bib to add CSL support and citation tooltips. However, integrating hayagriva for CSL functionality required rewriting most of the core logic, and the swappable template feature had to be removed in the process.

tl;dr: mdbook-bibtex supports all standard citation styles out-of-the-box, but currently lacks customizable appearance templates.