Add support for custom href prefix in footnotes#1
Merged
Conversation
Co-authored-by: ChenPi11 <102936596+ChenPi11@users.noreply.github.com>
Co-authored-by: ChenPi11 <102936596+ChenPi11@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add footnote hash support for custom href prefix
Add support for custom href prefix in footnotes
Nov 8, 2025
ChenPi11
requested changes
Nov 8, 2025
package-lock.json
Outdated
Owner
There was a problem hiding this comment.
Please remove package-lock.json.
Owner
|
@copilot Please solve the requested changes: "Please remove package-lock.json." |
Co-authored-by: ChenPi11 <102936596+ChenPi11@users.noreply.github.com>
Author
ChenPi11
approved these changes
Nov 8, 2025
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
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.
Summary
This PR adds support for customizing the
hrefattribute prefix in footnote links via theenv.footnoteHrefPrefixparameter. This addresses the feature request to make footnote hash support custom href (often prefix), similar to the pattern used in markdown-it-github-headings.Changes Made
env.footnoteHrefPrefixCore Implementation
render_footnote_href_prefix()helper function that returns the custom prefix fromenv.footnoteHrefPrefixor defaults to#render_footnote_ref()to use the custom href prefix for footnote referencesrender_footnote_anchor()to use the custom href prefix for back-referencesUse Cases
This feature enables:
/docs/page#fn1)https://example.com/docs#fn1)docIdfor both custom IDs and custom hrefsDocumentation
docIdTests
docIdand custom href prefixBackward Compatibility
#when not specifiedenv.docIdfeatureOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.