Footnote nodes pushed to the end of `Document`'s children

[mfontanini]

Parsing the following markdown while enabling the footnotes options produces an AST where the footnote definition is placed at the end of the Document node's children list. This seems deliberate in comrak, I'm wondering why that's the case. I get it that footnote definitions should in general come at the end, but this has popped up in presenterm (see mfontanini/presenterm#766) where a markdown file contains presentation slides so footnotes may appear in any slides within a markdown file, not necessarily all packed at the end. Could this behavior at least be configurable so some option can be turned on such that footnote definitions nodes show up where they belong based on their position in the input?

A test[^1]

[^1]: https://example.com

Boop:

[kivikakk]

I'm assuming (long time ago this was originally written!) it was done like this to make it easier to actually format the document with all the definitions at the end, so the default formatters don't have to do any special work regarding footnotes, but there's no reason why we can't make this configurable for when the default formatters aren't being used.

Did you want to have a go at a PR to make this change? I'd be happy to help you with it, if so. Otherwise, I can do it myself when I have some free time.

[mfontanini]

I see, that makes sense. I don't have much free time now and probably won't be able to get to this in the near future so if you feel like it, go for it! 🙏

[kivikakk]

The next Comrak release will have the parse.leave_footnote_definitions option, which addresses this :)

[kivikakk]

This was released in Comrak v0.48.0!