Add citations/footnotes using remark-gfm - #171
Open
DylanB5402 wants to merge 1 commit into
Open
Conversation
github-actions
Bot
added
Curriculum material
|
🌐 Preview URL: https://pr-171.frcsoftware.pages.dev |
zachwaffle4
requested changes
Aug 2, 2026
zachwaffle4
left a comment
zachwaffle4
left a comment
Member
There was a problem hiding this comment.
Starlight natively supports GFM footnotes, the remark plugin is unnecessary.
Contributor
|
I dig the idea of having footnotes, although I think that they need to be more visually striking. I also think that the footnote section needs different formatting (currently, it seemingly inserts an invisible header) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Put together citations/footnote to refer to wpilib or vendordep docs using remark-gfm. Pretty sure this is failing CI right now, wanted to get thoughts on whether we actually like doing citations like this before moving forward with cleaning it up and adding them to the rest of 1b.
See the bottom of this page to see what the footnotes actually look like on a page:
https://pr-171.frcsoftware.pages.dev/learning-course/stage1/stage1b/commands-and-mechanisms/
For #169