<commit_before>mdx_bibtex
==========

A proof-of-concept bibtex extension for Python markdown.



## Loading a bibliography

First of all, you need to indicate a bibliography to use this extension. You can do that from python, 

    import markdown
    import mdx_bibtex
    md=markdown.Markdown(extensions=['bibtex(bibliography=example.bib)'])
    
or, if you are using the `Meta` extension, with the `Meta` key `bibliography`

    Bibliography: example.bib
    Title: Nifty title
    
    Neat, you're ready to use the bibliography.
    
    
## Using the bibliography

Supported syntax.

<table>
<thead>
<tr>
<th>Use</th>
<th>To get</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@(wiles95)</code></td>
<td><a class="citation" data-key="wiles95" data-locator="" data-modifier="" data-prefix="" href="#wiles95">(Wiles 1995)</a></td>
</tr>
<tr>
<td><code>@(wiles95,bennet70)</code></td>
<td><span class="citation-multiple"><span class="citation-open-par">(</span><a class="citation" data-key="wiles95" data-locator="" data-modifier="" data-prefix="" href="#wiles95">Wiles 1995</a><span class="citation-comma">, </span><a class="citation" data-key="bennet70" data-locator="" data-modifier="" data-prefix="" href="#bennet70">Bennett 1970</a><span class="citation-close-par">)</span></span></td>
</tr>
<tr>
<td><code>@(wiles95)[p. 11]</code></td>
<td><a class="citation" data-key="wiles95" data-locator="p. 11" data-modifier="" data-prefix="" href="#wiles95">(Wiles 1995, p. 11)</a></td>
</tr>
<tr><commit_msg>Added description for basic usage<commit_after>mdx_bibtex
==========

A proof-of-concept bibtex extension for Python markdown.



## Loading a bibliography

First of all, you need to indicate a bibliography to use this extension. You can do that from python, 

    import markdown
    import mdx_bibtex
    md=markdown.Markdown(extensions=['bibtex(bibliography=example.bib)'])
    
or, if you are using the `Meta` extension, with the `Meta` key `bibliography`

    Bibliography: example.bib
    Title: Nifty title
    
    Neat, you're ready to use the bibliography.
    
    
## Using the bibliography

The most basic syntax is `@(key)` to cite a key from your bib file. Other possibilities:

<table>
<thead>
<tr>
<th>Use</th>
<th>To get</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@(wiles95)</code></td>
<td><a class="citation" data-key="wiles95" data-locator="" data-modifier="" data-prefix="" href="#wiles95">(Wiles 1995)</a></td>
</tr>
<tr>
<td><code>@(wiles95,bennet70)</code></td>
<td><span class="citation-multiple"><span class="citation-open-par">(</span><a class="citation" data-key="wiles95" data-locator="" data-modifier="" data-prefix="" href="#wiles95">Wiles 1995</a><span class="citation-comma">, </span><a class="citation" data-key="bennet70" data-locator="" data-modifier="" data-prefix="" href="#bennet70">Bennett 1970</a><span class="citation-close-par">)</span></span></td>
</tr>
<tr>
<td><code>@(wiles95)[p. 11]</code></td>
<td><a class="citation" data-key="wiles95" data-locator="p. 11" data-modifier="" data-prefix="" href="#wiles95">(Wiles 1995, p. 11)</a></td>
</tr>
<tr>
{'fraction_non_alphanumeric': 0.202000645369474, 'fraction_numerical': 0.02968699580509842, 'mean_word_length': 5.262626262626263, 'pattern_counts': {'":': 0, '<': 105, '<?xml version=': 0, '>': 105, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '848120', 'n_tokens_mistral': 1200, 'n_tokens_neox': 1081, 'n_words': 265}