Skip to content

Canonicalize Markdown docs to HTML and return real 404s #1265

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
tannerlinsley wants to merge 2 commits into
base: taren/local-docs-directory-bridge
Choose a base branch
from
Open

Canonicalize Markdown docs to HTML and return real 404s #1265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da44d93
fix(seo): canonicalize Markdown docs to HTML
tannerlinsley Sep 12, 2026
393bbb1
Merge branch 'taren/local-docs-directory-bridge' into taren/docs-mark…
tannerlinsley Sep 12, 2026
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
24 changes: 20 additions & 4 deletions src/routes/_library/$libraryId/$version.docs.framework.$framework.{$}[.]md.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { findLibrary, getBranch } from '~/libraries'
import { buildDocsMarkdownRedirectHref, loadDocsRoute } from '~/utils/docs'
import { notFound, createFileRoute } from '@tanstack/react-router'
import {
appendPathToDocsHref,
buildDocsMarkdownRedirectHref,
loadDocsRoute,
} from '~/utils/docs'
import { canonicalUrl } from '~/utils/seo'
import { createFileRoute } from '@tanstack/react-router'
import { getDocsCacheHeaders } from '~/utils/docs-cache-headers'
import { getContentDispositionHeader } from '~/utils/http-response'
import { filterFrameworkContent } from '~/utils/markdown/filterFrameworkContent'
Expand Down Expand Up @@ -31,7 +36,7 @@ export const Route = createFileRoute(
const library = findLibrary(libraryId)

if (!library) {
throw notFound()
return new Response('Not found', { status: 404 })
}

const root = library.docsRoot || 'docs'
Expand All @@ -41,6 +46,7 @@ export const Route = createFileRoute(
const result = await loadDocsRoute({
repo: library.repo,
branch,
latestBranch: getBranch(library, 'latest'),
docsRoot: root,
docsPath: requestedDocsPath,
defaultDocs: library.defaultDocs ?? 'overview',
Expand All @@ -63,7 +69,7 @@ export const Route = createFileRoute(
}

if (result.type === 'not-found') {
throw notFound()
return new Response('Not found', { status: 404 })
}

const doc = result.doc
Expand All @@ -82,6 +88,16 @@ export const Route = createFileRoute(
headers: {
...cacheHeaders,
'Content-Type': 'text/markdown',
Link: `<${canonicalUrl(
appendPathToDocsHref({
libraryId,
version:
result.latestDocsPath || version === library.latestVersion
? 'latest'
: version,
docsPath: result.latestDocsPath ?? result.docsPath,
}),
)}>; rel="canonical"`,
'Content-Disposition': getContentDispositionHeader(
'inline',
filename,
Expand Down
24 changes: 20 additions & 4 deletions src/routes/_library/$libraryId/$version.docs.{$}[.]md.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { createFileRoute, notFound } from '@tanstack/react-router'
import { createFileRoute } from '@tanstack/react-router'
import { findLibrary, getBranch } from '~/libraries'
import { buildDocsMarkdownRedirectHref, loadDocsRoute } from '~/utils/docs'
import {
appendPathToDocsHref,
buildDocsMarkdownRedirectHref,
loadDocsRoute,
} from '~/utils/docs'
import { canonicalUrl } from '~/utils/seo'
import { getDocsCacheHeaders } from '~/utils/docs-cache-headers'
import { getContentDispositionHeader } from '~/utils/http-response'
import { filterFrameworkContent } from '~/utils/markdown/filterFrameworkContent'
Expand All @@ -27,7 +32,7 @@ export const Route = createFileRoute(
const library = findLibrary(libraryId)

if (!library) {
throw notFound()
return new Response('Not found', { status: 404 })
}

const root = library.docsRoot || 'docs'
Expand All @@ -36,6 +41,7 @@ export const Route = createFileRoute(
const result = await loadDocsRoute({
repo: library.repo,
branch,
latestBranch: getBranch(library, 'latest'),
docsRoot: root,
docsPath,
defaultDocs: library.defaultDocs ?? 'overview',
Expand All @@ -56,7 +62,7 @@ export const Route = createFileRoute(
}

if (result.type === 'not-found') {
throw notFound()
return new Response('Not found', { status: 404 })
}

const doc = result.doc
Expand All @@ -77,6 +83,16 @@ export const Route = createFileRoute(
headers: {
...cacheHeaders,
'Content-Type': 'text/markdown',
Link: `<${canonicalUrl(
appendPathToDocsHref({
libraryId,
version:
result.latestDocsPath || version === library.latestVersion
? 'latest'
: version,
docsPath: result.latestDocsPath ?? result.docsPath,
}),
)}>; rel="canonical"`,
'Content-Disposition': getContentDispositionHeader(
'inline',
filename,
Expand Down
Loading