Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support custom heading IDs for cross-section linking #349

Open
gschulze opened this issue Sep 18, 2023 · 0 comments
Open

Support custom heading IDs for cross-section linking #349

gschulze opened this issue Sep 18, 2023 · 0 comments

Comments

@gschulze
Copy link

When linking to a heading within a markdown file, one has to rely on auto-generated heading IDs, which are a lowercase, hyphenated version of the heading text. IDs for headings with the same name are constructed by appending a number that is incremented according to the occurrence of the heading within the document. This is especially problematic if one wants to link to sections from outside of GitHub, as these identifiers are unstable in a sense that rewording of the heading text or changing the order of sections leads to different identifiers.

The markdown extended syntax mentions a possibility to specify custom heading IDs, which unfortunately is currently not supported by GFM: https://www.markdownguide.org/extended-syntax/#heading-ids

I think this feature would be a really nice addition as it greatly improves link stability and consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant