Skip to main content

Citeproc extension for Python-Markdown

Project description

md_citeproc

This package is in Alpha. While I'm trying to avoid it, the API might be subject to change.

Full Documentation: Readthedocs

Python Markdown extension to render citeproc-style references and citations in Markdown documents. This extension aims to be highly configurable to accommodate a wide variety of use cases, notation styles and bibliographic conventions.

Features

  • Render citations based on a CSL style sheet and bibliographic data in CSLJSON
  • Adapt to different notation styles and output styles
  • Optionally, adjust rendering details by using Jinja templates
  • Render footnotes and bibliographies
  • Add uncited items to the bibliography on rendering

Architecture

Under the hood, this extension uses the Nodejs package citeproc-cli for the rendering process, which itself is based on citeproc-js.

While this architecture limits the portability of the extension, it seems necessary to offer a feature-complete citeproc rendering process. To make things a little easier for a lot of users, pkg-packaged executables for the operating system families Windows, MacOS and Linux on the amd64 platform are shiped with the extension. On these platforms, the extension can run without nodejs or additional configuration. On other platforms, either a citeproc-cli installation or a pkg-packaged executable of citeproc-cli for the target platform is necessary to use the extension, the latter can be specified in the configuration of the extension.

Links

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

md_citeproc-0.1.7.tar.gz (42.1 MB view details)

Uploaded Source

File details

Details for the file md_citeproc-0.1.7.tar.gz.

File metadata

  • Download URL: md_citeproc-0.1.7.tar.gz
  • Upload date:
  • Size: 42.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for md_citeproc-0.1.7.tar.gz
Algorithm Hash digest
SHA256 46b4591b5c297948324ebab4a0f687c4cc00bb4d7132975e18527d554e70bb6a
MD5 256fe587d0d19b02a0d6cdbd1feba432
BLAKE2b-256 9c89a3290fe898e5479ba6c28b031218c2f83aa6701b080a06d0232fd1d5f75f

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