{"id":13930196,"url":"https://github.com/jacob-pro/mdbook-bibfile-referencing","last_synced_at":"2025-07-19T12:31:55.188Z","repository":{"id":38328226,"uuid":"386380642","full_name":"jacob-pro/mdbook-bibfile-referencing","owner":"jacob-pro","description":"An mdBook preprocessor to add bibfile referencing to each page","archived":false,"fork":false,"pushed_at":"2024-01-22T21:42:53.000Z","size":106,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-08-08T18:26:44.512Z","etag":null,"topics":["citeproc","mdbook","mdbook-pandoc","mdbook-preprocessor","pandoc-citeproc","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jacob-pro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-15T17:58:08.000Z","updated_at":"2024-03-13T18:03:00.000Z","dependencies_parsed_at":"2023-01-27T03:31:40.544Z","dependency_job_id":null,"html_url":"https://github.com/jacob-pro/mdbook-bibfile-referencing","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-pro%2Fmdbook-bibfile-referencing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-pro%2Fmdbook-bibfile-referencing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-pro%2Fmdbook-bibfile-referencing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jacob-pro%2Fmdbook-bibfile-referencing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jacob-pro","download_url":"https://codeload.github.com/jacob-pro/mdbook-bibfile-referencing/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226607607,"owners_count":17658483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["citeproc","mdbook","mdbook-pandoc","mdbook-preprocessor","pandoc-citeproc","rust"],"created_at":"2024-08-07T18:05:05.873Z","updated_at":"2024-11-26T19:30:56.267Z","avatar_url":"https://github.com/jacob-pro.png","language":"Rust","funding_links":[],"categories":["rust"],"sub_categories":[],"readme":"# mdBook Bibfile Referencing\n\n[![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)\n[![crates.io](https://img.shields.io/crates/v/mdbook-bibfile-referencing.svg)](https://crates.io/crates/mdbook-bibfile-referencing)\n\nAn mdBook preprocessor that uses Pandoc to add referencing to each chapter from a bibfile.\n\n## Usage\n\nIn your `book.toml` just specify:\n\n```\n[preprocessor.bibliography]\ncommand = \"mdbook-bibfile-referencing bibliography.bib ieee.csl\"\n```\n\nYou must include the path to the bibliography, followed by the path to your CSL (Citation Style Language) file\nwhich defines the style of the generated references \n(you can download pre-made ones [here](https://github.com/citation-style-language/styles)).\n\nIn each chapter of your book markdown source you can use the references in the format `[@key, PAGE_NUMBER]` -\nsee the [Pandoc Citeproc Docs](https://pandoc.org/demo/example19/Extension-citations.html) for the full syntax.\n\n## Install\n\n**Make sure you have [Pandoc Installed](https://pandoc.org/installing.html)**.\n\n```\ncargo install mdbook-bibfile-referencing\n```\n\n## Usage in CI/CD\n\nThere is a docker image: `ghcr.io/jacob-pro/mdbook-bibfile-referencing:latest` provided to make it simple and fast to \nbuild an mdbook in a CI system. For example in GitHub Actions you could have:\n\n```\njobs:\n  deploy:\n    runs-on: ubuntu-18.04\n    container:\n      image: ghcr.io/jacob-pro/mdbook-bibfile-referencing:latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Build book\n        run: mdbook build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacob-pro%2Fmdbook-bibfile-referencing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjacob-pro%2Fmdbook-bibfile-referencing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjacob-pro%2Fmdbook-bibfile-referencing/lists"}