mirror of
https://github.com/supabase/supabase.git
synced 2026-09-22 13:37:53 +08:00
bf60e6cdce
## 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>
107 lines
2.8 KiB
TypeScript
107 lines
2.8 KiB
TypeScript
import fs from 'fs'
|
|
import path from 'path'
|
|
|
|
const BASE_URL = 'https://supabase.com/library/docs'
|
|
|
|
interface DocMeta {
|
|
title: string
|
|
description?: string
|
|
path: string
|
|
}
|
|
|
|
console.log('🤖 Building llms.txt')
|
|
|
|
// Function to extract frontmatter from MDX files
|
|
function extractFrontmatter(content: string): { title?: string; description?: string } {
|
|
const frontmatterRegex = /---\n([\s\S]*?)\n---/
|
|
const match = content.match(frontmatterRegex)
|
|
if (!match) return {}
|
|
|
|
const frontmatter = match[1]
|
|
const titleMatch = frontmatter.match(/title:\s*(.*)/)
|
|
const descriptionMatch = frontmatter.match(/description:\s*(.*)/)
|
|
|
|
return {
|
|
title: titleMatch?.[1],
|
|
description: descriptionMatch?.[1],
|
|
}
|
|
}
|
|
|
|
// Function to recursively get all MDX files
|
|
function getMdxFiles(dir: string): string[] {
|
|
const files: string[] = []
|
|
const entries = fs.readdirSync(dir, { withFileTypes: true })
|
|
|
|
for (const entry of entries) {
|
|
const fullPath = path.join(dir, entry.name)
|
|
if (entry.isDirectory()) {
|
|
files.push(...getMdxFiles(fullPath))
|
|
} else if (entry.name.endsWith('.mdx')) {
|
|
files.push(fullPath)
|
|
}
|
|
}
|
|
|
|
return files
|
|
}
|
|
|
|
// Function to get all MDX files and their metadata
|
|
function getDocFiles(): DocMeta[] {
|
|
const docsDir = path.join(process.cwd(), 'content/docs')
|
|
const mdxFiles = getMdxFiles(docsDir).sort((a, b) => a.localeCompare(b))
|
|
|
|
const docs: DocMeta[] = []
|
|
|
|
for (const fullPath of mdxFiles) {
|
|
console.log(fullPath)
|
|
const content = fs.readFileSync(fullPath, 'utf-8')
|
|
const { title, description } = extractFrontmatter(content)
|
|
|
|
if (title) {
|
|
// Get relative path and convert to URL path
|
|
const relativePath = path.relative(docsDir, fullPath)
|
|
const urlPath = relativePath
|
|
.replace(/\.mdx$/, '')
|
|
.replace(/\/index$/, '')
|
|
.replace(/\\/g, '/')
|
|
|
|
docs.push({
|
|
title,
|
|
description,
|
|
path: urlPath,
|
|
})
|
|
}
|
|
}
|
|
|
|
return docs
|
|
}
|
|
|
|
// Generate the llms.txt content
|
|
const docs = getDocFiles()
|
|
let content = `# Supabase Library
|
|
Last updated: ${new Date().toISOString()}
|
|
|
|
## Overview
|
|
Library of components for your project. The components integrate with Supabase and are shadcn compatible. Each docs page is also available as markdown for agents (append .md to the URL).
|
|
|
|
## Docs
|
|
`
|
|
|
|
// Add documentation links
|
|
for (const doc of docs) {
|
|
const url = `${BASE_URL}/${doc.path}.md`
|
|
content += `- [${doc.title}](${url})`
|
|
if (doc.description) {
|
|
content += `\n - ${doc.description}`
|
|
}
|
|
content += '\n'
|
|
}
|
|
|
|
// Write the file
|
|
const publicDir = path.join(process.cwd(), 'public')
|
|
if (!fs.existsSync(publicDir)) {
|
|
fs.mkdirSync(publicDir, { recursive: true })
|
|
}
|
|
|
|
fs.writeFileSync(path.join(publicDir, 'llms.txt'), content)
|
|
console.log('✅ Generated llms.txt in public directory')
|