swiftlang/swift-markdown

Usage of footers and other markdown extension

NioDeBacker opened this issue · 2 comments

NioDeBacker commented

I am using DocC and trying to add a footnote (using [^1] this is possible in gfm, including cmark-gfm) but it doesn't work. Can someone tell me if this has been implemented or is going to be implemented in swift-markdown?

Example footnote 1

Footnotes

  1. Explanation of footnote ↩

QuietMisdreavus commented

Footnotes are enabled in cmark-gfm (and swift-cmark) via an option passed to the parser. We currently do not enable footnotes:

https://github.com/apple/swift-markdown/blob/ad0b81fed55c4a72fdaeb5535884bd2886de96f4/Sources/Markdown/Parser/CommonMarkConverter.swift#L598-L601

It's possible to add it there to turn it on, though i'd want to make sure that we supported it properly in the MarkupWalker protocols and rendered it properly in Swift-DocC and Swift-DocC-Render to be confident in it.

  • 👍1
NioDeBacker commented

Okay thank you for the information!