mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 18:35:07 +03: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>
113 lines
3.8 KiB
JSON
113 lines
3.8 KiB
JSON
{
|
|
"name": "library",
|
|
"version": "0.1.0",
|
|
"private": true,
|
|
"type": "module",
|
|
"scripts": {
|
|
"preinstall": "npx only-allow pnpm",
|
|
"dev": "next dev --port 3004",
|
|
"predev": "pnpm run build:markdown",
|
|
"build": "pnpm run content:build && pnpm run build:registry && pnpm run build:markdown && pnpm run build:llms && pnpm run build:app",
|
|
"build:registry": "rimraf -G public/r/* && tsx ./scripts/build-registry.mts && shadcn build public/r/registry.json && tsx scripts/clean-registry.ts",
|
|
"build:markdown": "tsx ./scripts/build-markdown.ts",
|
|
"build:llms": "tsx ./scripts/build-llms-txt.ts",
|
|
"test:markdown": "tsx --test scripts/library-mdx-to-markdown.test.ts",
|
|
"test:middleware": "pnpm run build:markdown && tsx --test middleware.test.ts",
|
|
"build:app": "next build --turbopack",
|
|
"start": "next start",
|
|
"lint": "eslint .",
|
|
"lint:mdx": "supa-mdx-lint content --config ../../supa-mdx-lint.config.toml",
|
|
"content:build": "contentlayer2 build",
|
|
"clean": "rimraf .next .turbo tsconfig.tsbuildinfo",
|
|
"typecheck": "contentlayer2 build && tsc --noEmit -p tsconfig.json"
|
|
},
|
|
"dependencies": {
|
|
"@hookform/resolvers": "^3.1.1",
|
|
"@monaco-editor/react": "catalog:",
|
|
"@react-router/fs-routes": "^7.4.0",
|
|
"@supabase-labs/y-supabase": "0.1.0",
|
|
"@supabase/postgrest-js": "catalog:",
|
|
"@supabase/supa-mdx-lint": "0.2.6-alpha",
|
|
"@supabase/vue-blocks": "workspace:*",
|
|
"@tanstack/react-query": "~5.83.0",
|
|
"@xyflow/react": "^12.10.1",
|
|
"api-types": "workspace:*",
|
|
"axios": "^1.12.0",
|
|
"class-variance-authority": "^0.7.1",
|
|
"cmdk": "^1.1.1",
|
|
"common": "workspace:*",
|
|
"common-tags": "^1.8.2",
|
|
"contentlayer2": "0.4.6",
|
|
"eslint-config-supabase": "workspace:*",
|
|
"framer-motion": "^11.18.2",
|
|
"icons": "workspace:*",
|
|
"jotai": "^2.8.0",
|
|
"lucide-react": "*",
|
|
"monaco-editor": "catalog:",
|
|
"next": "catalog:",
|
|
"next-contentlayer2": "0.4.6",
|
|
"next-themes": "catalog:",
|
|
"openai": "^5.9.0",
|
|
"openapi-fetch": "0.12.4",
|
|
"radix-ui": "catalog:",
|
|
"react": "catalog:",
|
|
"react-dom": "catalog:",
|
|
"react-hook-form": "^7.71.2",
|
|
"react-markdown": "^10.1.0",
|
|
"react-wrap-balancer": "^1.1.0",
|
|
"recharts": "catalog:",
|
|
"rehype-autolink-headings": "^7.1.0",
|
|
"rehype-pretty-code": "^0.9.0",
|
|
"rehype-slug": "^6.0.0",
|
|
"remark": "^14.0.3",
|
|
"remark-code-import": "^1.2.0",
|
|
"remark-gfm": "^4.0.0",
|
|
"sonner": "^1.5.0",
|
|
"ui": "workspace:*",
|
|
"ui-patterns": "workspace:*",
|
|
"unist-util-visit": "^5.0.0",
|
|
"vaul": "^1.1.2",
|
|
"y-monaco": "^0.1.6",
|
|
"y-protocols": "^1.0.7",
|
|
"yjs": "^13.6.29",
|
|
"zod": "catalog:"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/core": "*",
|
|
"@react-router/dev": "^7.9.0",
|
|
"@shikijs/compat": "^1.1.7",
|
|
"@supabase/ssr": "catalog:",
|
|
"@supabase/supabase-js": "catalog:",
|
|
"@tanstack/react-router": "catalog:",
|
|
"@tanstack/react-start": "catalog:",
|
|
"@types/common-tags": "^1.8.4",
|
|
"@types/lodash": "^4.17.16",
|
|
"@types/mdast": "^3.0.15",
|
|
"@types/react": "catalog:",
|
|
"@types/react-dom": "catalog:",
|
|
"@typescript/native": "catalog:",
|
|
"config": "workspace:^",
|
|
"gray-matter": "^4.0.3",
|
|
"lodash": "catalog:",
|
|
"mdast-util-from-markdown": "^1.3.1",
|
|
"mdast-util-gfm": "^2.0.2",
|
|
"mdast-util-mdx": "^2.0.1",
|
|
"mdast-util-mdx-jsx": "^2.1.4",
|
|
"mdast-util-to-markdown": "^1.5.0",
|
|
"mdast-util-toc": "^6.1.1",
|
|
"micromark-extension-gfm": "^2.0.3",
|
|
"micromark-extension-mdxjs": "^1.0.1",
|
|
"postcss": "catalog:",
|
|
"react-dropzone": "^14.3.8",
|
|
"react-router": "^7.13.2",
|
|
"rimraf": "^4.1.3",
|
|
"shadcn": "^3.0.0",
|
|
"shiki": "^1.1.7",
|
|
"tailwindcss": "catalog:",
|
|
"tsconfig": "workspace:*",
|
|
"tsx": "catalog:",
|
|
"typescript": "catalog:",
|
|
"vite": "catalog:"
|
|
}
|
|
}
|