https://github.com/jacob-pro/mdbook-bibfile-referencing

An mdBook preprocessor to add bibfile referencing to each page
https://github.com/jacob-pro/mdbook-bibfile-referencing

citeproc mdbook mdbook-pandoc mdbook-preprocessor pandoc-citeproc rust

Last synced: 3 months ago
JSON representation

An mdBook preprocessor to add bibfile referencing to each page

• Host: GitHub
• URL: https://github.com/jacob-pro/mdbook-bibfile-referencing
• Owner: jacob-pro
• License: lgpl-2.1
• Created: 2021-07-15T17:58:08.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-01-22T21:42:53.000Z (10 months ago)
• Last Synced: 2024-07-08T10:39:30.737Z (4 months ago)
• Topics: citeproc, mdbook, mdbook-pandoc, mdbook-preprocessor, pandoc-citeproc, rust
• Language: Rust
• Homepage:
• Size: 104 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - jacob-pro/mdbook-bibfile-referencing - An mdBook preprocessor to add bibfile referencing to each page (rust)

README

        
# mdBook Bibfile Referencing

[![Build status](https://github.com/jacob-pro/mdbook-bibfile-referencing/actions/workflows/rust.yml/badge.svg)](https://github.com/jacob-pro/mdbook-bibfile-referencing/actions)

[![crates.io](https://img.shields.io/crates/v/mdbook-bibfile-referencing.svg)](https://crates.io/crates/mdbook-bibfile-referencing)

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](https://github.com/citation-style-language/styles)).

In each chapter of your book markdown source you can use the references in the format `[@key, PAGE_NUMBER]` -

see the [Pandoc Citeproc Docs](https://pandoc.org/demo/example19/Extension-citations.html) for the full syntax.

## Install

**Make sure you have [Pandoc Installed](https://pandoc.org/installing.html)**.

```

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

```