#mdbook #bibliography #preprocessor #bib #file-format #plugin

bin+lib mdbook-bib

mdbook plugin allowing to load and present a bibliography in BibLaTex format in your books and cite its references

6 releases

0.0.6 Sep 2, 2023
0.0.5 Apr 13, 2023
0.0.4 Sep 4, 2021
0.0.3 Apr 4, 2021
0.0.2 Feb 14, 2021

#1065 in Parser implementations

Download history 18/week @ 2024-07-24 5/week @ 2024-07-31 3/week @ 2024-08-21 14/week @ 2024-08-28 22/week @ 2024-09-04 72/week @ 2024-09-11 73/week @ 2024-09-18 124/week @ 2024-09-25 145/week @ 2024-10-02 52/week @ 2024-10-09

401 downloads per month

MPL-2.0 license

61KB
1.5K SLoC

mdbook-bib

A mdBook plugin for creating a bibliography & citations in your books.

Test status MPL-2.0 License Manual

Crate Crates.io

Features

  • Add citations from your BibLaText files
  • Automatically download your public bibliography from Zotero and cite it
  • Allows defining a template for the citations shown in the references page

Basic Install

If you have mdbook installed just do:

cargo install mdbook-bib

Make sure your PATH env var contains Cargo's /bin directory where the plugin was installed. Then follow the instructions below to use the plugin.

See all options in the Install section of the manual.

Add a BibLaTex File and Cite your Bib Entries!

Add a bibliography file in BibLaTex format to the root of your mdbook (which is pointed by the src parameter in the [book] section of the .toml file) and then add the following section to the mdbook's .toml config file:

[book]
#...
[preprocessor.bib]
bibliography = "my_biblio.bib"

The bibliography will appear as a separate section in your book ToC.

Now you can add references/citations to the citation-keys appearing in the .bib file with:

{{#cite my-citation-key}}

or simply with:

@@my-citation-key

See other configuration options in the Config section of the manual.

Contribute

Check the Contrib section of the manual if you want to contribute to mdbook-bib!

Dependencies

~17–32MB
~519K SLoC