Skip to main content

Allows the use of BibTeX citations within a Pelican site

Project description

pelican-cite

Allows the use of BibTeX citations within a Pelican site.

Installation

To install simply run pip install pelican-cite and add it to the PLUGINS section of pelicanconf.py

PLUGINS = [
    '...',
    'pelican.plugins.cite'
    '...',
]

How to Use

This plugin reads a user-specified BibTeX file and generates bibliographic information within your articles and pages.

Configuration is simply:

PUBLICATIONS_SRC = 'content/pubs.bib'

If the file is present and readable, then content will be scanned for references to citation keys. These take the format [@Bai2011] or [@@Bai2011]. These will be replaced by incline citations which provide links to the full bibliographic information at the end of the article. The former reference would be replaced by a citation of the form "Bai & Stone (2011)", while the latter would be replaced by "(Bai & Stone, 2011)".

If a citation key is used which does not exist within the BibTeX file then a warning will be displayed.

The BibTeX file may, optionally, be provided or overridden on a per-article basis by supplying the meta-data publications_src.

Attribution

pelican-cite is based on the pelican-bibtex plugin written by Vlad Niculae and pelican-cite written by Chris MacMackin.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pelican-cite-0.1.4.tar.gz (17.5 kB view hashes)

Uploaded Source

Built Distribution

pelican_cite-0.1.4-py3-none-any.whl (17.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page