mkdocs-bibtex icon indicating copy to clipboard operation
mkdocs-bibtex copied to clipboard

Possibility to insert a bibliography item inline, with footnote reference disabled (=manual bibliography with generated style)

Open smarie opened this issue 1 year ago • 2 comments

Hi, thanks a lot again for this plugin ! I am trying to use it to create a simple publications page for my personal website. Basically I would just like to create a page with a few sections, and insert in each section a bullet list with bibliographic items styled correctly leveraging pandoc + CSL.

I cannot manage to get it work because

  • if I do not cite anything from the .bib file, nothing is added into the generated markdown.
  • if I cite them, the generateg markdown is entirely managed by mkdocs-bibtex and therefore cannot be organized by type (journal, conferences, etc.). Plus, the citation has to go somewhere.

The current workaround I found is

  • to create a local copy of the APA style and edit the <citation> entry so that it is identical to <bibliography> (ugly !)
  • to set bib_by_default=false

Still, the result is not ideal. Indeed bib_by_default=false still inserts the footnotes references [^1], and since the bib is not generated they hang here in the resulting page

image

I see two features to create to get to something working:

  • adding a config option, or better a markdown hint, to tell mkdocs-bibtex that a specific citation key should be rendered inline using the "bibliography" style and not the "citation" style. For example [@foo2019] could be transformed as [@foo2019|b] where | denotes advanced options, and b denotes bibliography style.
  • adding a config option, or better a markdown hint as above, to tell mkdocs-bibtex to skip adding the markdown footnote [^1].

The combination of these two options would be reaching my objective, which is to insert at any place in the markdown document, an inlined bibliography item with the styling done by pandoc.

If you are ok with the above two features, I can make a pull request.

smarie avatar Jan 29 '24 23:01 smarie

Your solution sounds good to me. Please make a PR and thanks for your contributions.

shyamd avatar Feb 02 '24 23:02 shyamd

Hi ! I agree thanks a lot ! Since I'm also interested in this issue, I tried to implement it. I just opened a PR.

I hope my approach fits your expectations on this issue, I am not very experienced in contributing to python projects.

JPapir avatar Sep 13 '24 10:09 JPapir