Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 1.61 KB

README.md

File metadata and controls

47 lines (34 loc) · 1.61 KB
Raw

mdBook Bibfile Referencing

Build status crates.io

An mdBook preprocessor that uses Pandoc to add referencing to each chapter from a bibfile.

Usage

In your book.toml just specify:

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

You must include the path to the bibliography, followed by the path to your CSL (Citation Style Language) file which defines the style of the generated references (you can download pre-made ones here).

In each chapter of your book markdown source you can use the references in the format [@key, PAGE_NUMBER] - see the Pandoc Citeproc Docs for the full syntax.

Install

Make sure you have Pandoc Installed.

cargo install mdbook-bibfile-referencing

Usage in CI/CD

There is a docker image: ghcr.io/jacob-pro/mdbook-bibfile-referencing:latest provided to make it simple and fast to build an mdbook in a CI system. For example in GitHub Actions you could have:

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