Skip to content

Fix broken integration README anchors by aligning heading slugify with GitHub #5348

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.

Sign up for GitHub

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

Merged
Yndira-E merged 1 commit into from
Jul 20, 2026
Merged

Fix broken integration README anchors by aligning heading slugify with GitHub #5348

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion nuxt/server/utils/integrations-enrich.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,23 @@ const GITHUB_HEADERS = {
Accept: 'application/vnd.github+json'
}

// Mirrors GitHub's own heading slugger so anchors written against a README's
// GitHub-rendered preview (e.g. `#egm-optional` for "## EGM (optional)") keep resolving here.
function githubSlugify (heading: string): string {
return encodeURIComponent(
heading
.trim()
.toLowerCase()
.replace(/[^\w一-龥\- ]/g, '')
.replace(/\s+/g, '-')
)
}

const md = new MarkdownIt({ html: true })
.use(MarkdownItAnchor, { permalink: MarkdownItAnchor.permalink.headerLink() })
.use(MarkdownItAnchor, {
slugify: githubSlugify,
permalink: MarkdownItAnchor.permalink.headerLink()
})
.use(MarkdownItFootnote)
.use(MarkdownItAttrs)

Expand Down