shyamd / mkdocs-bibtex

A MkDocs plugin for citation management using bibtex
Other
79 stars 21 forks source link

mkdocs-bibtex does not render citations where a period (.) exists in the key #170

Closed NixImagery closed 1 year ago

NixImagery commented 1 year ago

When rendering a site with mkdocs using the mkdocs-bibtex plugin, citations are not recognised if they have a period within the citation key.

I tried a minimum working example and could reproduce the behaviour. To reproduce the behaviour, set up a folder containing the files below and run the command mkdocs serve. The browser should render both citations correctly but it only functions as expected for the citation key without the period.

MWE

Site structure:

index.md

# Home

Blah blah [@Jarse2023]. 

Woof woof [@Jarse.2023]

mkdocs.yml

site_name: MWE
docs_dir: docs
site_dir: site

plugins: 
  - search
  - bibtex:
      bib_file: mwe.bib

markdown_extensions:
  - footnotes

mwe.bib

@article{Jarse2023,
author = {Jarse, Hugh},
journal = {Beano},
title = {{The width of seats on urban public transport}},
year = {2023}
}
@article{Jarse.2023,
author = {Jarse, Hugh},
journal = {Beano},
title = {{The width of seats on urban public transport}},
year = {2023}
}
shyamd commented 1 year ago

Haven't forgotten this. Just haven't had time to really work on it. I'm trying to get the tests refactored so they are grouped by feature so i can keep track of what is breaking better.

shyamd commented 1 year ago

Should be working with v2.8.13