mirror of
https://github.com/supabase/supabase.git
synced 2026-05-09 10:19:50 -04:00
d409836ca7
## Summary Adds `/<page>.md` routes for 10 marketing/product pages (homepage, auth, database, edge-functions, realtime, storage, vector, pricing, modules/cron, modules/queues) so AI agents can fetch clean markdown instead of parsing JS-rendered HTML. Also advertises the markdown alternate via `<link rel="alternate" type="text/markdown">` on marketing and docs pages so agents can discover it. Pricing is generated dynamically via `generatePricingContent()` (single source of truth with `/llms.txt` and `/llms-full.txt`); the other nine slugs are bundled at build time from `content/md/*.md` into a `MD_CONTENT` map. Supersedes #44891 (rebased fresh off current master to avoid a 9-commit replay over rename/rename conflicts created by #44897). ## Changes - New `/api-v2/md/[...slug]` route handler returns the bundled markdown (or dynamic pricing) with `Content-Type: text/markdown`, `X-Content-Type-Options: nosniff`, and appropriate cache headers - Middleware rewrites `/<slug>.md` and `Accept: text/markdown` to the API route for the `MD_PAGES` allowlist; trailing-slash variants (`/auth/`) are normalized so they resolve the same as `/auth` - Build-time codegen `scripts/generateMdContent.mjs` scans `content/md/` and emits `app/api-v2/md/content.generated.ts` exporting both `MD_CONTENT` (Map) and `MD_PAGES` (Set, incl. dynamic `pricing`). Fails the build on slug collision between `content/md/` and `DYNAMIC_SLUGS`. Adding a new marketing `.md` is just dropping a file in `content/md/` (also update `PRODUCT_OVERVIEW_LINKS` in `/llms.txt` since that list is editorial). - 8 permanent redirects `/llms/<product>.txt` → `/<product>.md` so legacy URLs in caches and downstream `llms.txt` copies keep working - `/llms.txt` product overview now references `.md` URLs (incl. `modules/cron`, `modules/queues`); `/llms-full.txt` iterates `MD_CONTENT.values()` (homepage first, then alphabetical) and appends dynamic pricing - `/llms/[slug]` route slimmed to proxy SDK reference files (`js.txt`, `dart.txt`, etc.) since redirects handle product slugs and pricing; pricing branch retained as fallback in case redirects are bypassed - `apps/www/pages/_app.tsx` injects the alternate link conditionally based on `MD_PAGES`; `/pricing` (app router) sets it via page metadata - `apps/docs/app/page.tsx` (the `/docs` root) sets the text/markdown alternate to `/llms-full.txt`; per-guide pages override with their specific `.md` URL via `genGuideMeta` in `GuidesMdx.utils.tsx`. Other docs pages (reference, troubleshooting) inherit nothing. - `apps/www/.vercelignore`: replaces the prior `*.md`/`README.md` rules with `*.md` + `!content/md/**/*.md` so Edge Function READMEs and future scratch `.md` files aren't silently shipped to the build artifact - Drops `apps/www/data/llms/*.txt` and the related `outputFileTracingIncludes` - Test coverage for the new middleware branches: `.md` suffix rewrite (allowlisted vs. fall-through), `Accept: text/markdown` content negotiation, trailing-slash normalization ## Testing (Vercel preview) Local dev server smoke tests passing on `:3771` after each iteration. Re-verified on the preview URL after the latest hardening commit: - [x] `curl -I https://<preview>/llms/auth.txt` — expect `308 Permanent Redirect` to `/auth.md` - [x] `curl https://<preview>/auth.md | head -3` — expect `# Supabase Auth` - [x] `curl https://<preview>/pricing.md | head -3` — expect `# Supabase Pricing` with current tier values - [x] `curl https://<preview>/modules/cron.md | head -3` — expect `# Supabase Cron` - [x] `curl -H 'Accept: text/markdown' https://<preview>/ | head -3` — expect `# Supabase` (homepage.md) - [x] `curl https://<preview>/llms.txt` — Product Overview section lists `.md` URLs and includes Cron + Queues - [x] `curl https://<preview>/llms-full.txt | grep -E '^# Supabase (Cron\|Queues\|Pricing)'` — Cron and Pricing each match once; Queues matches twice (marketing module + existing docs guide) - [x] View source on `/`, `/pricing`, `/database` — expect `<link rel="alternate" type="text/markdown" href="/<slug>.md">` - [x] View source on `/docs` — expect `<link rel="alternate" type="text/markdown" href="/llms-full.txt">` - [x] View source on a docs guide page (e.g., `/docs/guides/auth`) — expect per-guide `.md` alternate; reference/troubleshooting pages should NOT emit a markdown alternate - [x] `curl -I https://<preview>/auth.md` — expect `X-Content-Type-Options: nosniff` - [x] `curl -I -L -H 'Accept: text/markdown' https://<preview>/auth/` — should resolve to markdown content (trailing-slash normalization, with Vercel's auto-redirect) ## Linear - fixes GROWTH-760 ## Follow-up (separate PR) GROWTH-760 also asks about extending `.md` to blog/customers/events. Different mechanism (path-prefix middleware, MDX read at request time via `gray-matter`) so it deserves its own review. Will open a follow-up PR after this lands. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Serve prebuilt and dynamic Markdown docs via new markdown endpoints and routing; pages now advertise markdown alternates (including pricing). * Added Cron and Queues module documentation pages. * **Documentation** * Minor formatting tweaks to Realtime and Storage docs. * **Chores** * Added build-time Markdown content generation and adjusted ignore/deploy rules for generated files. * Added redirects from legacy text-based product URLs to new markdown pages. * **Tests** * Expanded tests for markdown routing and content-negotiation behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
390 lines
12 KiB
TypeScript
390 lines
12 KiB
TypeScript
import { isFeatureEnabled } from 'common'
|
|
import { type Metadata, type ResolvingMetadata } from 'next'
|
|
import Link from 'next/link'
|
|
import { cn, IconBackground } from 'ui'
|
|
import { IconPanel } from 'ui-patterns/IconPanel'
|
|
import { TextLink } from 'ui-patterns/TextLink'
|
|
|
|
import MenuIconPicker from '@/components/Navigation/NavigationMenu/MenuIconPicker'
|
|
import { MIGRATION_PAGES } from '@/components/Navigation/NavigationMenu/NavigationMenu.constants'
|
|
import { GlassPanelWithIconPicker } from '@/features/ui/GlassPanelWithIconPicker'
|
|
import { IconPanelWithIconPicker } from '@/features/ui/IconPanelWithIconPicker'
|
|
import HomeLayout from '@/layouts/HomeLayout'
|
|
import { BASE_PATH } from '@/lib/constants'
|
|
|
|
const { sdkCsharp, sdkDart, sdkKotlin, sdkPython, sdkSwift } = isFeatureEnabled([
|
|
'sdk:csharp',
|
|
'sdk:dart',
|
|
'sdk:kotlin',
|
|
'sdk:python',
|
|
'sdk:swift',
|
|
])
|
|
|
|
const generateMetadata = async (_, parent: ResolvingMetadata): Promise<Metadata> => {
|
|
const parentAlternates = (await parent).alternates
|
|
|
|
return {
|
|
alternates: {
|
|
canonical: `${BASE_PATH}`,
|
|
...(parentAlternates && {
|
|
languages: parentAlternates.languages || undefined,
|
|
media: parentAlternates.media || undefined,
|
|
types: {
|
|
...(parentAlternates.types ?? {}),
|
|
'text/markdown': '/llms-full.txt',
|
|
},
|
|
}),
|
|
},
|
|
}
|
|
}
|
|
|
|
const products = [
|
|
{
|
|
title: 'Database',
|
|
icon: 'database',
|
|
hasLightIcon: true,
|
|
href: '/guides/database/overview',
|
|
description:
|
|
'Supabase provides a full Postgres database for every project with Realtime functionality, database backups, extensions, and more.',
|
|
span: 'col-span-12 md:col-span-6',
|
|
},
|
|
{
|
|
title: 'Auth',
|
|
icon: 'auth',
|
|
hasLightIcon: true,
|
|
href: '/guides/auth',
|
|
description:
|
|
'Add and manage email and password, passwordless, OAuth, and mobile logins to your project through a suite of identity providers and APIs.',
|
|
span: 'col-span-12 md:col-span-6',
|
|
},
|
|
{
|
|
title: 'Storage',
|
|
icon: 'storage',
|
|
hasLightIcon: true,
|
|
href: '/guides/storage',
|
|
description:
|
|
'Store, organize, transform, and serve large files—fully integrated with your Postgres database with Row Level Security access policies.',
|
|
},
|
|
{
|
|
title: 'Realtime',
|
|
icon: 'realtime',
|
|
hasLightIcon: true,
|
|
href: '/guides/realtime',
|
|
description:
|
|
'Listen to database changes, store and sync user states across clients, broadcast data to clients subscribed to a channel, and more.',
|
|
},
|
|
{
|
|
title: 'Edge Functions',
|
|
icon: 'edge-functions',
|
|
hasLightIcon: true,
|
|
href: '/guides/functions',
|
|
description:
|
|
'Globally distributed, server-side functions to execute your code closest to your users for the lowest latency.',
|
|
},
|
|
]
|
|
|
|
const postgresIntegrations = [
|
|
{
|
|
title: 'AI & Vectors',
|
|
icon: 'ai',
|
|
href: '/guides/ai',
|
|
description: 'AI toolkit to manage embeddings',
|
|
},
|
|
{
|
|
title: 'Cron',
|
|
icon: 'cron',
|
|
href: '/guides/cron',
|
|
description: 'Schedule and monitor recurring Jobs',
|
|
},
|
|
{
|
|
title: 'Queues',
|
|
icon: 'queues',
|
|
href: '/guides/queues',
|
|
description: 'Durable Message Queues with guaranteed delivery',
|
|
},
|
|
{
|
|
title: 'Data REST API',
|
|
icon: 'rest',
|
|
href: '/guides/api',
|
|
description: 'Access your database through a RESTful API.',
|
|
},
|
|
{
|
|
title: 'GraphQL API',
|
|
icon: 'graphql',
|
|
href: '/guides/graphql',
|
|
description: 'Access your database through a GraphQL API.',
|
|
},
|
|
]
|
|
|
|
const selfHostingOptions = [
|
|
{
|
|
title: 'Auth',
|
|
icon: 'auth',
|
|
href: '/reference/self-hosting-auth/introduction',
|
|
},
|
|
{
|
|
title: 'Realtime',
|
|
icon: 'realtime',
|
|
href: '/reference/self-hosting-realtime/introduction',
|
|
},
|
|
{
|
|
title: 'Storage',
|
|
icon: 'storage',
|
|
href: '/reference/self-hosting-storage/introduction',
|
|
},
|
|
{
|
|
title: 'Analytics',
|
|
icon: 'analytics',
|
|
href: '/reference/self-hosting-analytics/introduction',
|
|
},
|
|
]
|
|
|
|
const clientLibraries = [
|
|
{
|
|
title: 'JavaScript',
|
|
icon: 'reference-javascript',
|
|
href: '/reference/javascript/introduction',
|
|
enabled: true,
|
|
},
|
|
{
|
|
title: 'Flutter',
|
|
icon: 'reference-dart',
|
|
href: '/reference/dart/introduction',
|
|
enabled: sdkDart,
|
|
},
|
|
{
|
|
title: 'Python',
|
|
icon: 'reference-python',
|
|
href: '/reference/python/introduction',
|
|
enabled: sdkPython,
|
|
},
|
|
{
|
|
title: 'C#',
|
|
icon: 'reference-csharp',
|
|
href: '/reference/csharp/introduction',
|
|
enabled: sdkCsharp,
|
|
},
|
|
{
|
|
title: 'Swift',
|
|
icon: 'reference-swift',
|
|
href: '/reference/swift/introduction',
|
|
enabled: sdkSwift,
|
|
},
|
|
{
|
|
title: 'Kotlin',
|
|
icon: 'reference-kotlin',
|
|
href: '/reference/kotlin/introduction',
|
|
enabled: sdkKotlin,
|
|
},
|
|
]
|
|
|
|
const additionalResources = [
|
|
{
|
|
title: 'Management API',
|
|
description: 'Manage your Supabase projects and organizations.',
|
|
icon: 'reference-api',
|
|
href: '/reference/api/introduction',
|
|
},
|
|
{
|
|
title: 'Supabase CLI',
|
|
description: 'Use the CLI to develop, manage and deploy your projects.',
|
|
icon: 'reference-cli',
|
|
href: '/reference/cli/introduction',
|
|
},
|
|
{
|
|
title: 'Platform Guides',
|
|
description: 'Learn more about the tools and services powering Supabase.',
|
|
icon: 'platform',
|
|
href: '/guides/platform',
|
|
},
|
|
{
|
|
title: 'Integrations',
|
|
description: 'Explore a variety of integrations from Supabase partners.',
|
|
icon: 'integrations',
|
|
href: '/guides/integrations',
|
|
},
|
|
{
|
|
title: 'Supabase UI',
|
|
description: 'A collection of pre-built Supabase components to speed up your project.',
|
|
icon: 'ui',
|
|
href: 'https://supabase.com/ui',
|
|
external: true,
|
|
},
|
|
{
|
|
title: 'Troubleshooting',
|
|
description: 'Our troubleshooting guide for solutions to common Supabase issues.',
|
|
icon: 'troubleshooting',
|
|
href: '/guides/troubleshooting',
|
|
},
|
|
]
|
|
|
|
const HomePage = () => (
|
|
<HomeLayout>
|
|
<div className="flex flex-col">
|
|
<h2 id="products">Products</h2>
|
|
<ul className="grid grid-cols-12 gap-6 not-prose [&_svg]:text-brand-600">
|
|
{products.map((product) => {
|
|
return (
|
|
<li key={product.title} className={cn(product.span ?? 'col-span-12 md:col-span-4')}>
|
|
<Link href={product.href} passHref>
|
|
<GlassPanelWithIconPicker {...product}>
|
|
{product.description}
|
|
</GlassPanelWithIconPicker>
|
|
</Link>
|
|
</li>
|
|
)
|
|
})}
|
|
</ul>
|
|
|
|
<div className="flex flex-col lg:grid grid-cols-12 gap-6 py-12 border-b">
|
|
<div className="col-span-4">
|
|
<h2 id="postgres-integrations" className="scroll-mt-24 m-0">
|
|
Modules
|
|
</h2>
|
|
</div>
|
|
<div className="grid col-span-8 grid-cols-12 gap-6 not-prose">
|
|
{postgresIntegrations.map((integration) => (
|
|
<Link
|
|
href={integration.href}
|
|
key={integration.title}
|
|
passHref
|
|
className="col-span-6 md:col-span-4"
|
|
>
|
|
<IconPanelWithIconPicker {...integration} />
|
|
</Link>
|
|
))}
|
|
</div>
|
|
</div>
|
|
|
|
<div className="flex flex-col lg:grid grid-cols-12 gap-6 py-12 border-b">
|
|
<div className="col-span-4 flex flex-col gap-1 [&_h2]:m-0 [&_h3]:m-0">
|
|
<div className="md:max-w-xs 2xl:max-w-none">
|
|
<div className="flex items-center gap-3 mb-3 text-brand-600">
|
|
<h2 id="client-libraries" className="group scroll-mt-24">
|
|
Client Libraries
|
|
</h2>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="grid col-span-8 grid-cols-12 gap-6 not-prose">
|
|
{clientLibraries
|
|
.filter((library) => library.enabled)
|
|
|
|
.map((library) => {
|
|
return (
|
|
<Link
|
|
href={library.href}
|
|
key={library.title}
|
|
passHref
|
|
className="col-span-6 md:col-span-4"
|
|
>
|
|
<IconPanelWithIconPicker {...library} />
|
|
</Link>
|
|
)
|
|
})}
|
|
</div>
|
|
</div>
|
|
{isFeatureEnabled('docs:full_getting_started') && (
|
|
<div className="flex flex-col lg:grid grid-cols-12 gap-6 py-12 border-b">
|
|
<div className="col-span-4 flex flex-col gap-1 [&_h2]:m-0">
|
|
<h2 id="migrate-to-supabase" className="group scroll-mt-24">
|
|
Migrate to Supabase
|
|
</h2>
|
|
<p className="text-foreground-light text-sm p-0 m-0">
|
|
Bring your existing data, auth and storage to Supabase following our migration guides.
|
|
</p>
|
|
<TextLink
|
|
label="Explore more resources"
|
|
url="/guides/resources"
|
|
className="no-underline text-brand-link text-sm"
|
|
/>
|
|
</div>
|
|
|
|
<ul className="grid col-span-8 grid-cols-12 gap-6 not-prose">
|
|
{MIGRATION_PAGES.sort((a, b) => (a.name || '').localeCompare(b.name || '')).map(
|
|
(guide) => {
|
|
return (
|
|
<li key={guide.name} className="col-span-6 md:col-span-4">
|
|
<Link href={guide.url || '#'} passHref>
|
|
<IconPanel {...guide} title={guide.name} background={true} showLink={false} />
|
|
</Link>
|
|
</li>
|
|
)
|
|
}
|
|
)}
|
|
</ul>
|
|
</div>
|
|
)}
|
|
|
|
<div className="flex flex-col gap-6 py-12 border-b">
|
|
<div className="col-span-4 flex flex-col gap-1 [&_h2]:m-0 [&_h3]:m-0">
|
|
<h3 id="additional-resources" className="group scroll-mt-24">
|
|
Additional resources
|
|
</h3>
|
|
</div>
|
|
|
|
<ul className="grid grid-cols-12 gap-6 not-prose">
|
|
{additionalResources.map((resource) => {
|
|
return (
|
|
<li key={resource.title} className="col-span-12 md:col-span-6 lg:col-span-3">
|
|
<Link
|
|
href={resource.href}
|
|
className="col-span-12 md:col-span-6 lg:col-span-3"
|
|
passHref
|
|
target={resource.external ? '_blank' : undefined}
|
|
>
|
|
<GlassPanelWithIconPicker {...resource} background={false}>
|
|
{resource.description}
|
|
</GlassPanelWithIconPicker>
|
|
</Link>
|
|
</li>
|
|
)
|
|
})}
|
|
</ul>
|
|
</div>
|
|
{isFeatureEnabled('docs:full_getting_started') && (
|
|
<div className="flex flex-col lg:grid grid-cols-12 gap-6 py-12">
|
|
<div className="col-span-4 flex flex-col gap-1 [&_h2]:m-0 [&_h3]:m-0">
|
|
<div className="md:max-w-xs 2xl:max-w-none">
|
|
<div className="flex items-center gap-3 mb-3 text-brand-600">
|
|
<IconBackground>
|
|
<MenuIconPicker icon="self-hosting" width={18} height={18} />
|
|
</IconBackground>
|
|
<h3 id="self-hosting" className="group scroll-mt-24">
|
|
Self-Hosting
|
|
</h3>
|
|
</div>
|
|
<p className="text-foreground-light text-sm">
|
|
Get started with self-hosting Supabase.
|
|
</p>
|
|
<TextLink
|
|
label="More on Self-Hosting"
|
|
url="/guides/self-hosting"
|
|
className="no-underline text-brand-link text-sm"
|
|
/>
|
|
</div>
|
|
</div>
|
|
|
|
<div className="grid col-span-8 grid-cols-12 gap-6 not-prose">
|
|
<ul className="col-span-full lg:col-span-8 grid grid-cols-12 gap-6">
|
|
{selfHostingOptions.map((option) => {
|
|
return (
|
|
<li key={option.title} className="col-span-6">
|
|
<Link href={option.href} passHref>
|
|
<IconPanelWithIconPicker {...option} background={true} showLink={false} />
|
|
</Link>
|
|
</li>
|
|
)
|
|
})}
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
)}
|
|
</div>
|
|
</HomeLayout>
|
|
)
|
|
|
|
export default HomePage
|
|
export { generateMetadata }
|