From 2fd52ba85db415fd4d7ad56e2e789b7d437d1047 Mon Sep 17 00:00:00 2001 From: shyamd <16827130+shyamd@users.noreply.github.com> Date: Tue, 18 Jan 2022 11:24:17 -0800 Subject: [PATCH] update documentation on markdown conversion --- mkdocs_bibtex/plugin.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/mkdocs_bibtex/plugin.py b/mkdocs_bibtex/plugin.py index 81c181c..2c16e78 100644 --- a/mkdocs_bibtex/plugin.py +++ b/mkdocs_bibtex/plugin.py @@ -75,9 +75,13 @@ def on_page_markdown(self, markdown, page, config, files): Parses the markdown for each page, extracting the bibtex references If a local reference list is requested, this will render that list where requested - 1. Finds all cite keys - 2. Convert all the corresponding bib entries into citations - 3. Insert the ordered citation numbers into the markdown text + 1. Finds all cite keys (may include multiple citation references) + 2. Convert all cite keys to citation quads: + (full cite key, + induvidual cite key, + citation key in corresponding style, + citation for induvidual cite key) + 3. Insert formatted cite keys into text 4. Insert the bibliography into the markdown 5. Insert the full bibliograph into the markdown """