Search code examples
bibtexmkdocscitations

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

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:

  • MWE
    • docs
      • index.md
    • mkdocs.yml
    • mwe.bib

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}
}
Solution

  • This has been fixed in v2.8.13 of mkdocs-bibtex plugin.

    https://github.com/shyamd/mkdocs-bibtex/releases/tag/v2.8.13