Footnotes in mkdocs?

[etiennebacher]

eitsupi/neo-r-polars#321 (comment)

[etiennebacher]

---
title: "foo"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{foo}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

Hello there[^footnote].

[^footnote]: hi there

gets converted to this md file:

# foo


Hello there[1].

[1] hi there

which prevents footnotes from appearing correctly.

[etiennebacher]

Smaller reprex, foo.Rmd:

Hello there[^footnote].

[^footnote]: hi there

With quarto::quarto_render("foo.Rmd", output_format = "md") (which we use internally) or quarto::quarto_render("foo.Rmd", output_format = "commonmark"):

Hello there[1].

[1] hi there

With quarto::quarto_render("foo.Rmd", output_format = "gfm"):

Hello there[^1].

[^1]: hi there

Related to #296

[etiennebacher]

I said in the linked issue:

Since CommonMark is defined as "A strongly defined, highly compatible specification of Markdown", I'd prefer using it over gfm that seems very Github centric.

However it seems mkdocs(-material) uses the gfm syntax so we could at least change the output format depending on the documentation generator.

Edit:

• docsify supports the gfm syntax for footnotes (https://github.com/Robert-Du0001/docsify-footnote)
• quarto_website also supports it