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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pelican-cite-0.1.4.tar.gz.

File metadata

  • Download URL: pelican-cite-0.1.4.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.5 Darwin/19.2.0

File hashes

Hashes for pelican-cite-0.1.4.tar.gz
Algorithm Hash digest
SHA256 53cc5a3d21a4fd940459144c5d4c81e018a5fa968cfe9a0703bfd98a952aa05c
MD5 b44fcd94bc5f30f63a799a488892263c
BLAKE2b-256 5dfbb6e26f2eb807dea72ac371f5e2e9c5f2d2f8dc14b10fa3629a50f29c8565

See more details on using hashes here.

File details

Details for the file pelican_cite-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: pelican_cite-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.5 Darwin/19.2.0

File hashes

Hashes for pelican_cite-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0fa38bb4e387bcd8eb1ace14e7842ae502062af8e0d9512e3f080d50a7af6326
MD5 cb82b80c746ab57bb6e8dab0cd9e004a
BLAKE2b-256 52e590b6277759fc8ea05933c72ba36ca3aa4df2f289464ab620d8c991c7d9ff

See more details on using hashes here.

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