Support GitHub style markdown heading anchor and link reference#1540
Merged
Support GitHub style markdown heading anchor and link reference#1540
Conversation
Collaborator
|
🚀 Preview deployment available at: https://923ad884.rdoc-6cd.pages.dev (commit: 00bcfa6) |
st0012
force-pushed
the
support-github-style-markdown-heading-anchor
branch
3 times, most recently
from
f350f65 to
5172d55
Compare
Anchors Generated: | Context | Before | After | |---------|--------|-------| | Heading `== Hello` (standalone) | `id="label-Hello"` | `id="hello"` | | Heading `== Hello` (in class Foo) | `id="class-Foo-label-Hello"` | `id="class-foo-hello"` | | Heading `== Hello` (in method #bar) | `id="method-i-bar-label-Hello"` | `id="method-i-bar-hello"` | | Class/Module anchor | `id="class-Foo::Bar"` | `id="class-foo-bar"` | Legacy anchors preserved as hidden `<span class="legacy-anchor">` elements. Links Generated: | Syntax | Before | After | |--------|--------|-------| | `rdoc-ref:@foo` | `href="#label-foo"` | `href="#foo"` | | `rdoc-ref:Class@foo` | `href="#class-Class-label-foo"` | `href="#class-class-foo"` | | `rdoc-ref:Class#method@foo` | `href="#method-i-method-label-foo"` | `href="#method-i-method-foo"` | | `rdoc-ref:Class@Section Title` | `href="#Section Title"` | `href="#section-title"` | These changes now enable Markdown links to work with GitHub-style anchors. Markdown `[link](#foo)` passes through unchanged as `href="#foo"`. - Before: Anchor was `id="label-Foo"` -> link broken - After: Anchor is `id="foo"` -> link works Supportive Changes: - ToC sidebar links updated to use new anchor format
st0012
force-pushed
the
support-github-style-markdown-heading-anchor
branch
from
5172d55 to
00bcfa6
Compare
st0012
added a commit
that referenced
this pull request
Jan 4, 2026
1. README now has a better section about supported markup formats 2. RDoc markup related reference are now consolidated under `doc/markup_reference/rdoc.rdoc` 3. Markdown markup now has a more comprehensive reference in `doc/markup_reference/markdown.md` (#1536, #1538, #1540, and #1541 were all discovered when I was preparing for this PR 😄)
Contributor
I don't believe this is working as intended. I've seen PRs like ruby/ruby#15963 (among others) so I guess something unexpected is happening? |
Member
Author
|
@Earlopain Thanks for reporting this. I'll take a look. It may be related to #1590 as well |
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
4 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.
I started the work to address #1537, but I think we should just go with the GH markdown style anchor/link generation in the future.
Anchors Generated:
== Hello(standalone)id="label-Hello"id="hello"== Hello(in class Foo)id="class-Foo-label-Hello"id="class-foo-hello"== Hello(in method #bar)id="method-i-bar-label-Hello"id="method-i-bar-hello"id="class-Foo::Bar"id="class-foo-bar"Legacy anchors preserved as hidden
<span class="legacy-anchor">elements. So links targeting old anchors should still work.Links Generated:
rdoc-ref:@foohref="#label-foo"href="#foo"rdoc-ref:Class@foohref="#class-Class-label-foo"href="#class-class-foo"rdoc-ref:Class#method@foohref="#method-i-method-label-foo"href="#method-i-method-foo"rdoc-ref:Class@Section Titlehref="#Section Title"href="#section-title"These changes now enable Markdown links to work with GitHub-style anchors.
Markdown
[link](#foo)passes through unchanged ashref="#foo".id="label-Foo"-> link brokenid="foo"-> link worksSupportive Changes:
Closes #1537