grafana / dataplane

Grafana data plane tools and docs
https://grafana.com/developers/dataplane
Apache License 2.0
9 stars 3 forks source link

Move footnotes into the table as inline notes #47

Closed samjewell closed 3 weeks ago

samjewell commented 3 weeks ago

Fixes #46

There's a limitation in Markdown that footnotes such as [^6] cannot be rendered when found within table cells. So the last three footnotes are entirely broken. They look like this in the body:

Screenshot 2024-10-14 at 22 08 00

And this at the footer (ie. they are missing):

image

Perplexity AI tells me that this is not possible, and gives a few possible reasons: https://www.perplexity.ai/search/why-can-t-i-use-markdown-footn-L.TQdIMSSmeCn4QugvC8tw#0

Rather than have these completely broken, I figured we should render them properly. This is what I found which I considered to be a reasonable solution.

In the process I also figured I should fix the references for the first three footnotes on this page at the same time.

The notes now look like this, when I run yarn docs locally:

image and image

EDIT Since the PR review, they now look like this:

See the notes which were broken before rendered immediately after the Notes heading, and before the numbered footnotes.

image