https://github.com/gabrielzschmitz/bibinject
Inject BibTeX into your HTML pages.
https://github.com/gabrielzschmitz/bibinject
bibtex flask html latex python
Last synced: 4 months ago
JSON representation
Inject BibTeX into your HTML pages.
- Host: GitHub
- URL: https://github.com/gabrielzschmitz/bibinject
- Owner: gabrielzschmitz
- License: mit
- Created: 2025-05-16T01:26:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-11T06:12:37.000Z (7 months ago)
- Last Synced: 2025-12-12T01:54:01.053Z (7 months ago)
- Topics: bibtex, flask, html, latex, python
- Language: Python
- Homepage: https://bibinject.vercel.app
- Size: 1.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BibInject
**BibInject** is a Python tool for parsing `.bib` (BibTeX) files and generating
valid, styled HTML references. It supports injecting these references directly
into existing HTML files at predefined targets.
Built with simplicity in mind, BibInject helps you keep your bibliography
organized and presentation-ready without the overhead of complex pipelines.
It's perfect for blogs, project pages, or academic sites that need lightweight
citation integration without relying on JavaScript-based renderers or external
services.
Includes:
- CLI tool and Github Actions example for automation
- Optional Flask web interface
---
## 🛠️ Prerequisites
- [Python 3.0+](https://www.python.org/)
- [pip](https://pip.pypa.io/en/stable/)
- [virtualenv](https://virtualenv.pypa.io/)
- [Flask](https://flask.palletsprojects.com/en/stable/)
---
## 🚀 Installation
### 1. Clone the repository
```sh
git clone https://github.com/gabrielzschmitz/BibInject.git
cd BibInject
````
### 2. Run the setup to install all dependencies
```sh
./setup.sh
```
---
## ⚙️ CLI Usage
Convert a `.bib` file and inject the result into an HTML element:
```sh
./bibinject.sh \
--input input.bib \
--refspec apa \
--html target.html \
--target-id references \
--order desc \
--group year \
--doi-icon static/doi.svg \
output.html
```
* `--input=`:
Path to the BibTeX (`.bib`) file containing the reference entries to be
processed.
* `--refspec=`:
Reference formatting style (e.g., `apa`, `abnt`). Determines how the
citations will be rendered.
* `--html=`:
Path to the HTML file into which the generated reference list will be
injected.
* `--target-id=`:
The `id` attribute of the `
` in the HTML file where the references
should be inserted.
* `--order=`:
Sorting order for the references (ascending or descending). Usually based on
year.
* `--group=`:
Group the output by a BibTeX field (e.g., `year`, `author`). Groups are
rendered as section headers.
* `--doi-icon=`:
Optional DOI icon to display next to DOI links.
* Provide a path to an SVG/PNG file (e.g., `static/doi.svg`).
* `` (positional argument):
Output HTML file to write, containing the injected reference list.
---
## 🌐 Web Interface
Start a local web server:
```sh
./bibinject.sh --web
```
Demonstration of the Web Interface
This launches a browser-friendly interface where you can upload `.bib` files,
preview the injected output, and download the updated HTML at:
`http://127.0.0.1:6969`
If you prefer not to run the app locally or install anything, you can use the
hosted version of **BibInject** at:
**[https://bibinject.vercel.app](https://bibinject.vercel.app)**
---
## 🔄 GitHub Action Integration
You can automate BibInject as part of your deployment workflow. An example is
provided in `.github/workflow/inject-on-deploy.yaml`, showing how to run
BibInject before publishing your website. This ensures your citation list is
always regenerated and up-to-date on every deploy.
```yaml
name: Injection Action
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
bibinject:
name: Injection Test
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Clone BibInject
run: |
git clone https://github.com/gabrielzschmitz/BibInject.git tools/BibInject
- name: Install BibInject
run: |
cd tools/BibInject
./setup.sh
- name: Run BibInject
run: |
cd tools/BibInject
# Inject Publications
./bibinject.sh \
--input ../../refs.bib \
--refspec abnt \
--html ../../publications.html \
--target-id publications \
--order desc \
../../publications.html
- name: Prepare deployment folder
run: |
mkdir public
shopt -s extglob
cp -r !(tools|public) public/
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: public/
# Deploy your page only after BibInject has completed.
# deploy:
# needs: build
# runs-on: ubuntu-latest
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
#
# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4
```
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE)
file for details.