Skip to content

fix(seo): emit a single H1 on generated API reference pages #94

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

Open
coderdan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(seo): emit a single H1 on generated API reference pages #94

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
11 changes: 10 additions & 1 deletion scripts/lib/docs-generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,16 @@ export async function generateDocsForTag(
expandObjects: true,
hideBreadcrumbs: true,
hidePageHeader: false,
hidePageTitle: false,
// The page template emits `# <symbol>` as the body's first line, and
// Fumadocs renders `page.data.title` as an <h1> above it — the same string
// twice, so every generated page shipped two H1s. Suppressing TypeDoc's
// copy leaves Fumadocs' as the only one; the text is identical, so nothing
// changes visually.
//
// This is `hidePageTitle`, not the `hidePageHeader` above it: the heading
// in typedoc-plugin-markdown's `reflection.template.js` is gated on the
// former. `hidePageHeader` controls the breadcrumb/navigation block.
hidePageTitle: true,
parametersFormat: "list",
expandParameters: false,
useHTMLEncodedBrackets: true,
Expand Down