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.2.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

pelican_cite-0.1.2-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pelican-cite-0.1.2.tar.gz
  • Upload date:
  • Size: 17.6 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.2.tar.gz
Algorithm Hash digest
SHA256 4d1371ead37f4643d7448416872e2c526a62604e07b80779397fa662d40e778f
MD5 4180313b6ad66d1e6c5a5927295a725d
BLAKE2b-256 7960a27fd7a8ea8d44d4dac4091194f0fc2aab0ef2fb8e34ab11ca01dde12234

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pelican_cite-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 17.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1498394ed79d55e640ce7a4cffe664b7432230cf907f90b3cd084557352124d6
MD5 ff1914952b9e3fe682ef8a91d9b71e4d
BLAKE2b-256 507fb9f5c171dbb12a9250474ae21a1fac0f54107a3cb0345c7f56489f371de2

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