Add footnotes. #228
Open
Add footnotes. #228
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This relies on the footnote extension in cmark, which does not expose footnote type names, but does expose enough information via the type enum.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This relies on the footnote extension in cmark, which does not expose footnote type names, but does expose enough information via the type enum.
Bug/issue #, if applicable:
Summary
Adds new footnote types FootnoteDefinition and FootnoteReference to the markdown tree.
Dependencies
None. It would be nice to use swiftlang/swift-cmark#57, but it's not necessary; there's a small hack that can reliably detect when cmake produces footnotes.
This is heavily based on #129, which also adds footnote support; however, that PR does rely on the upstream swift-cmark PR, whereas this one does not.
Testing
New test introduced to verify the parsing of footnotes, which pass with
./bin/test.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded