footnotes sorting script

[hellt]

Hi everyone,
has anyone come up with a script that would sort the footnotes in a document?

E.g. when you have smth like this:

some text[^1]

more text[^2]

[^1]: note 1
[^2]: note 2

and then you add another line inbetween

some text[^1]

new line[^3]

more text[^2]

[^1]: note 1
[^2]: note 2
[^3]: note 3

your footnotes become unsorted. OCD kicks in...

[squidfunk]

You know that you can use any identifier to link to footnotes? I'm also mostly using numbers, but you can use ^whateveryoulike, which might appeal more to your OCD 😅 I'm on the same boat, btw.

[hellt]

yeah, what trips me is the ordering in the rendered superscript (which is always a number, not configurable in mkdocs-material), because it will be unordered as you read the document.

I think what I'd likely appreciate more is the annotation icon as the superscript. E.g. the same (+) sign, but as a superscript so that it doesn't stand out as much as its inline version.

[hellt]

Okay, last night I decided to google the footnote sorter examples, expecting that there should've been poor souls suffering from this.

I found a 11 y.o project, which I refactored to support rich footnote content and different styling of footnotes.

https://github.com/hellt/markdown-footnote-sorter

Usage:

docker run --rm -v $(pwd):/work ghcr.io/hellt/markdown-footnote-sorter path/to/doc.md

fnsorter.mp4

[squidfunk]

Nice, great work!