md-citeproc 0.2.1

Citeproc extension for Python-Markdown

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

• Documentation
• Source Code
• Issue Tracker
• citeproc-cli@npm