mdbook-bib

Crates.iomdbook-bib
lib.rsmdbook-bib
version0.0.6
sourcesrc
created_at2021-02-10 02:39:16.502229
updated_at2023-09-02 20:05:57.383598
descriptionmdbook plugin allowing to load and present a bibliography in BibLaTex format in your books and cite its references
homepage
repositoryhttps://github.com/francisco-perez-sorrosal/mdbook-bib
max_upload_size
id353011
size144,964
Francisco PĂ©rez-Sorrosal (francisco-perez-sorrosal)

documentation

README

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!

Commit count: 91

cargo fmt