mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
Our UI Library registry is expanding to include blocks that go beyond UI and in some cases focus purely on back-end. This PR is a precursor to adding more back-end related blocks. This PR includes the `ui-library -> library` rename plus redirects and small UI copy updates. Since this is a rename we'll need to update Vercel configuration. ## Vercel rollout Keep the Library project Root Directory as `apps/ui-library` 1. In the **Library** Vercel project, set: `NEXT_PUBLIC_BASE_PATH=/library` Apply it to Preview and Production, then redeploy the Library project. 2. In the **www** Vercel project, add: `NEXT_PUBLIC_LIBRARY_URL=<current value of NEXT_PUBLIC_UI_LIBRARY_URL>` Apply it to Preview and Production. Keep `NEXT_PUBLIC_UI_LIBRARY_URL` during the migration, then redeploy the www project. 3. Deploy in this order: 1. Library project 2. www project 4. Validate: - `/library` - `/library/docs/nextjs/password-based-auth` - `/ui` redirects to `/library` - `/ui/docs/nextjs/password-based-auth` redirects to `/library/docs/nextjs/password-based-auth` - `/ui/docs/ai-editors-rules/*` still uses its existing Docs redirects No Vercel dashboard redirect rules are needed. Environment-variable changes require a new deployment. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Supabase UI Library has been renamed to **Supabase Library** across navigation, pages, documentation, and resource links. * The Library is now available at `/library`, with updated descriptions covering components, blocks, and developer tools. * **Bug Fixes** * Added permanent redirects from legacy `/ui` URLs to corresponding `/library` paths. * Updated links throughout the site and documentation to prevent broken navigation and references. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
107 lines
2.7 KiB
TypeScript
107 lines
2.7 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')
|
|
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 = `# Learn Supabase
|
|
Last updated: ${new Date().toISOString()}
|
|
|
|
## Overview
|
|
Library of components for your project. The components integrate with Supabase and are shadcn compatible.
|
|
|
|
## Docs
|
|
`
|
|
|
|
// Add documentation links
|
|
for (const doc of docs) {
|
|
const url = `${BASE_URL}/${doc.path}`
|
|
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')
|