mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +08:00
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Feature: agent-readable markdown pages for the UI library docs. ## What is the current behavior? Library docs are HTML-only. `llms.txt` lists page titles, but there is no `.md` body an agent can fetch. ## What is the new behavior? Each docs page is also served as markdown: - Build-time MDX → markdown (`pnpm --filter library build:markdown`) - `GET /library/docs/{slug}.md` (and `Accept: text/markdown`) - HTML pages advertise `rel=alternate` `text/markdown` - `llms.txt` links to the `.md` URLs This is the base of a stack. The prompt-tab PR sits on top: https://github.com/supabase/supabase/pull/49566 ## Additional context Interactive previews are omitted from the markdown. `BlockItem` emits the production `npx shadcn add` command so agents still get an install path. ## To test 1. `pnpm --filter library dev` (generates markdown in `predev`). 2. Open http://localhost:3004/library/docs/nextjs/password-based-auth.md — markdown with the install command, file tree, and setup steps; no interactive previews. 3. Open the same path without `.md` — HTML docs unchanged (no prompt tab in this PR). 4. `curl -H 'Accept: text/markdown' http://localhost:3004/library/docs/nextjs/password-based-auth` should also return markdown. 5. http://localhost:3004/library/llms.txt — links should end in `.md`. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Documentation pages are available as Markdown through `.md` URLs and a dedicated endpoint. * Markdown is generated automatically during development and production builds. * Generated content preserves front matter, links, callouts, installation instructions, and supported documentation elements. * Installation commands support npm, pnpm, yarn, and bun for React and Vue projects. * **Bug Fixes** * Improved Markdown file handling, link rewriting, and content negotiation. * **Tests** * Added coverage for Markdown conversion, content negotiation, and installation commands. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: Saxon Fletcher <SaxonF@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
44 lines
1.2 KiB
TypeScript
44 lines
1.2 KiB
TypeScript
import { promises as fs } from 'node:fs'
|
|
import path from 'node:path'
|
|
import { NextResponse } from 'next/server'
|
|
|
|
export async function GET(_request: Request, { params }: { params: Promise<{ slug: string[] }> }) {
|
|
const { slug } = await params
|
|
const baseDir = path.join(process.cwd(), 'public/markdown/docs')
|
|
const filePath = path.join(baseDir, `${slug.join('/')}.md`)
|
|
|
|
if (!filePath.startsWith(baseDir + path.sep) && filePath !== baseDir) {
|
|
return markdownNotFound(slug)
|
|
}
|
|
|
|
try {
|
|
const content = await fs.readFile(filePath, 'utf-8')
|
|
return new NextResponse(content, {
|
|
headers: {
|
|
'Content-Type': 'text/markdown; charset=utf-8',
|
|
'Cache-Control': 'public, max-age=86400, stale-while-revalidate=3600',
|
|
Vary: 'Accept',
|
|
},
|
|
})
|
|
} catch {
|
|
return markdownNotFound(slug)
|
|
}
|
|
}
|
|
|
|
function markdownNotFound(slug: string[]) {
|
|
const pagePath = slug.join('/')
|
|
const markdown = `# 404 - Page Not Found
|
|
|
|
The page \`/library/docs/${pagePath}.md\` does not exist.
|
|
|
|
See also: [Supabase Library](https://supabase.com/library/llms.txt)
|
|
`
|
|
return new NextResponse(markdown, {
|
|
status: 404,
|
|
headers: {
|
|
'Content-Type': 'text/markdown; charset=utf-8',
|
|
'Cache-Control': 'no-store',
|
|
},
|
|
})
|
|
}
|