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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pelican-cite-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 e45005c0f77afd70edd157e2c007fa8efd9ac093d79c7180181ecdcf82e7f886
MD5 7c522774e2935a6024b0a3520611a967
BLAKE2b-256 99173093c9aaa77024b02db07719dcfc8b1cde54a26563ce103617e6a3021cfb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pelican_cite-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 04a9236bf2eeac7429c1ce63490c00c898dcc1688c4d6af3b49297a5be446432
MD5 184fa7dc13467a66e2af7356f2412ee7
BLAKE2b-256 7825bf6bd730faa7f4f453a9d5a356511ddcbe042e19d77648f65b4ef5e03b08

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