Skip to content

fix: resolve same-page fragment links via AnchorHyperlinkResolver#1301

Open
jonathanhefner wants to merge 1 commit intophpDocumentor:mainfrom
jonathanhefner:fix-markdown-same-page-fragment-links
Open

fix: resolve same-page fragment links via AnchorHyperlinkResolver#1301
jonathanhefner wants to merge 1 commit intophpDocumentor:mainfrom
jonathanhefner:fix-markdown-same-page-fragment-links

Conversation

@jonathanhefner
Copy link

⚠️ Disclaimer: This was vibe-coded. I am not a PHP developer, but I am helping https://github.com/modelcontextprotocol/php-sdk set up documentation using phpDocumentor, and I encountered this issue. (See also modelcontextprotocol/php-sdk#232.) I guided Claude through the investigation and self-review, but I am unable to personally judge the fix.


Same-page fragment links in markdown (e.g., [Section](#section-one)) were producing bare #section-one URLs because ExternalReferenceResolver intercepted all #-prefixed references and set bare fragment URLs, preventing AnchorHyperlinkResolver from resolving them to canonical URLs.

When combined with a <base href> tag in the HTML template (used by phpDocumentor for subdirectory pages), browsers resolve bare fragment URLs against the base URL rather than the current page, causing table-of-contents links to navigate away instead of scrolling.

Remove the str_starts_with('#') branch from ExternalReferenceResolver so fragment-only references are no longer claimed as "external". Instead, AnchorHyperlinkResolver now handles them: it looks up the anchor in the project's internal targets and produces a canonical URL (e.g., /index.html#section-one). When no target matches (e.g., RST explicit fragment hyperlinks like `link <#abc>`__), it falls back to the bare fragment URL to preserve backward compatibility.

Same-page fragment links in markdown (e.g., `[Section](#section-one)`)
were producing bare `#section-one` URLs because
`ExternalReferenceResolver` intercepted all `#`-prefixed references and
set bare fragment URLs, preventing `AnchorHyperlinkResolver` from
resolving them to canonical URLs.

When combined with a `<base href>` tag in the HTML template (used by
phpDocumentor for subdirectory pages), browsers resolve bare fragment
URLs against the base URL rather than the current page, causing
table-of-contents links to navigate away instead of scrolling.

Remove the `str_starts_with('#')` branch from
`ExternalReferenceResolver` so fragment-only references are no longer
claimed as "external". Instead, `AnchorHyperlinkResolver` now handles
them: it looks up the anchor in the project's internal targets and
produces a canonical URL (e.g., `/index.html#section-one`). When no
target matches (e.g., RST explicit fragment hyperlinks like
`` `link <#abc>`__ ``), it falls back to the bare fragment URL to
preserve backward compatibility.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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

Successfully merging this pull request may close these issues.

1 participant