Citeproc extension for Python markdown
Project description
citeproc-markdown
Python markdown extension to convert a CSL data block in markdown to a styled bibliography in the HTML output. Requires a citeproc-js server in order to work.
Example
Markdown source
# The origins of the term _anthropocene_
The term _anthropocene_ has been coined by Crutzen and Stoermer in the year 2000.
```csl-yaml
- id: crutzenAnthropocene2000
author:
- family: Crutzen
given: P.J.
- family: Stoermer
given: E.F.
container-title: Global Change Newsletter
issued:
raw: "2000"
page: 17-18
title: The “Anthropocene”
type: article-journal
volume: '41'
```
We use a fenced code block to store the CSL data. The data language is defined directly after the first backticks as csl-<language>
, where <language>
is the language the bibliographic data is stored in. Supported values are yaml
, json
and json5
.
Python conversion snippet
from markdown import markdown
markdown(
content, extensions=['citeproc'],
extension_configs={
'citeproc': {
'citeproc_endpoint': 'DEFINE_ENDPOINT_HERE'
}
}
)
Alternatively, the endpoint can also be defined through the environment variable CITEPROC_ENDPOINT
, either in memory or in a .env
or settings.ini
file in the working directory.
HTML output
<h1>The origins of the term <em>anthropocene</em></h1>
<p>The term <em>anthropocene</em> has been coined by Crutzen and Stoermer in the year 2000.</p>
<div class="csl-bib-body">
<div class="csl-entry">Crutzen, P.J., and E.F. Stoermer. 2000. “The ‘Anthropocene.’” <i>Global Change Newsletter</i> 41: 17–18.</div>
</div>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file citeproc-markdown-0.2.tar.gz
.
File metadata
- Download URL: citeproc-markdown-0.2.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24833201f3e7de7148c6bb4368a5c12e9237278b18295f12d6f3fba19a71f069 |
|
MD5 | c42d3e7a9c711fee0f781f44d349cde2 |
|
BLAKE2b-256 | c22dad19c0ed3b36000bb5b57d92f7c3d43df6caa3eb58d239661706fddc7030 |