Fix broken heading links #472
Open
rohitpaulk wants to merge 1 commit into
Open
Conversation
|
@rohitpaulk is attempting to deploy a commit to the Ghostty Team on Vercel. A member of the Team first needs to authorize it. |
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.
Problem
On https://ghostty.org/docs/features/ssh, the in-page
[shell integration](#shell-integration)link is broken. It points to#shell-integration, but the heading on that page actually renders withid="shell-integration-2".Root cause
In
src/lib/docs/remark-heading-ids.mjs, theencounteredIDsMap used to de-duplicate heading IDs is created in the plugin factory scope:Next.js instantiates the remark plugin once (see
next.config.mjs) and reuses it for every MDX file, so the counter persists across documents. Multiple docs contain a "Shell Integration" heading (docs/features/ssh.mdx,docs/install/release-notes/1-3-0.mdx,docs/install/release-notes/1-3-1.mdx), so they get slugs likeshell-integration-2,shell-integration-3etc.Fix
Move the
encounteredIDsMap inside the returned per-document transformer so the counter resets for each file.Validation
Verified with a real
npm run buildand inspection of the generated static HTML:docs/features/ssh.html: heading id goes fromshell-integration-2toshell-integration(i.e. previously broken link now works)docs/install/build.html(two### Dependenciesheadings): still correctly producesdependenciesanddependencies-2