Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 29 additions & 1 deletion src/routes/$libraryId/$version.docs.$.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
import { seo } from '~/utils/seo'
import { Doc } from '~/components/Doc'
import { loadDocs } from '~/utils/docs'
import {
loadDocs,
prefersMarkdown,
createMarkdownResponse,
} from '~/utils/docs'
import { findLibrary, getBranch, getLibrary } from '~/libraries'
import { DocContainer } from '~/components/DocContainer'
import { notFound } from '@tanstack/react-router'

export const ServerRoute = createServerFileRoute().methods({
GET: async ({ request, params }) => {
const acceptHeader = request.headers.get('Accept')

if (prefersMarkdown(acceptHeader)) {
const url = new URL(request.url)
const { libraryId, version, _splat: docsPath } = params
const library = getLibrary(libraryId)
const root = library.docsRoot || 'docs'

const doc = await loadDocs({
repo: library.repo,
branch: getBranch(library, version),
docsPath: `${root}/${docsPath}`,
currentPath: url.pathname,
redirectPath: `/${library.id}/${version}/docs/overview`,
})

return createMarkdownResponse(doc.title, doc.content)
}
},
})

export const Route = createFileRoute({
staleTime: 1000 * 60 * 5,
loader: (ctx) => {
Expand Down Expand Up @@ -43,6 +70,7 @@ export const Route = createFileRoute({
return {
'cache-control': 'public, max-age=0, must-revalidate',
'cdn-cache-control': 'max-age=300, stale-while-revalidate=300, durable',
'vary': 'Accept',
}
},
})
Expand Down
36 changes: 35 additions & 1 deletion src/routes/$libraryId/$version.docs.framework.$framework.$.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
import { seo } from '~/utils/seo'
import { Doc } from '~/components/Doc'
import { loadDocs } from '~/utils/docs'
import {
loadDocs,
prefersMarkdown,
createMarkdownResponse,
} from '~/utils/docs'
import { getBranch, getLibrary } from '~/libraries'
import { capitalize } from '~/utils/utils'
import { DocContainer } from '~/components/DocContainer'

export const ServerRoute = createServerFileRoute().methods({
GET: async ({ request, params }) => {
const acceptHeader = request.headers.get('Accept')

if (prefersMarkdown(acceptHeader)) {
const url = new URL(request.url)
const { libraryId, version, framework, _splat: docsPath } = params
const library = getLibrary(libraryId)
const root = library.docsRoot || 'docs'

const doc = await loadDocs({
repo: library.repo,
branch: getBranch(library, version),
docsPath: `${root}/framework/${framework}/${docsPath}`,
currentPath: url.pathname,
redirectPath: `/${library.id}/${version}/docs/overview`,
})

return createMarkdownResponse(doc.title, doc.content)
}
},
})

export const Route = createFileRoute({
staleTime: 1000 * 60 * 5,
loader: (ctx) => {
Expand Down Expand Up @@ -36,6 +63,13 @@ export const Route = createFileRoute({
}),
}
},
headers: (ctx) => {
return {
'cache-control': 'public, max-age=0, must-revalidate',
'cdn-cache-control': 'max-age=300, stale-while-revalidate=300, durable',
'vary': 'Accept',
}
},
})

function Docs() {
Expand Down
39 changes: 39 additions & 0 deletions src/utils/docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,42 @@ export const fetchAllMaintainerStats = createServerFn({
}
})
*/

// Helper function to check if the Accept header prefers markdown
export function prefersMarkdown(acceptHeader: string | null): boolean {
if (!acceptHeader) return false

const accepts = acceptHeader.split(',').map(type => {
const [mediaType, ...params] = type.trim().split(';')
const quality = params.find(p => p.trim().startsWith('q='))
const q = quality ? parseFloat(quality.split('=')[1]) : 1.0
return { mediaType: mediaType.toLowerCase(), q }
})

const markdownQ = accepts.find(a =>
a.mediaType === 'text/markdown' || a.mediaType === 'text/plain'
)?.q || 0

const htmlQ = accepts.find(a =>
a.mediaType === 'text/html' || a.mediaType === '*/*'
)?.q || 0

return markdownQ > 0 && markdownQ > htmlQ
}

// Helper function to create markdown response
export function createMarkdownResponse(
title: string,
content: string
): Response {
const markdownContent = `# ${title}\n${content}`

return new Response(markdownContent, {
headers: {
'Content-Type': 'text/markdown; charset=utf-8',
'Cache-Control': 'public, max-age=0, must-revalidate',
'Cdn-Cache-Control': 'max-age=300, stale-while-revalidate=300, durable',
'Vary': 'Accept',
},
})
}
Loading