Skip to content

Commit

Permalink
update documentation on markdown conversion
Browse files Browse the repository at this point in the history
  • Loading branch information
shyamd committed Jan 18, 2022
1 parent 65542c2 commit 2fd52ba
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions mkdocs_bibtex/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down

0 comments on commit 2fd52ba

Please sign in to comment.