Files
supabase/apps/ui-library/middleware.test.ts
Saxon Fletcher bf60e6cdce feat(library): serve agent-readable markdown for each docs page (#49567)
## 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>
2026-09-01 11:35:55 +10:00

51 lines
1.6 KiB
TypeScript

import assert from 'node:assert/strict'
import { describe, it } from 'node:test'
import { NextRequest } from 'next/server'
import { middleware } from './middleware'
const DOCS_URL = 'https://supabase.com/library/docs/nextjs/client'
function request(url: string, headers: Record<string, string>) {
return new NextRequest(new Request(url, { headers }))
}
describe('middleware markdown negotiation', () => {
it('rewrites to the markdown route when Accept prefers markdown', () => {
const response = middleware(request(DOCS_URL, { accept: 'text/markdown' }))
assert.equal(
response.headers.get('x-middleware-rewrite'),
'https://supabase.com/library/api/docs-md/nextjs/client'
)
})
it('406s when Accept rejects both html and markdown', () => {
const response = middleware(request(DOCS_URL, { accept: 'application/json' }))
assert.equal(response.status, 406)
})
it('passes Server Action requests through untouched', () => {
// Server Actions POST to the page URL with `Accept: text/x-component`.
const response = middleware(
request(DOCS_URL, {
accept: 'text/x-component',
'next-action': '7f1e0c0d5a1b2c3d4e5f60718293a4b5c6d7e8f900',
})
)
assert.equal(response.status, 200)
assert.equal(response.headers.get('x-middleware-rewrite'), null)
})
it('serves html to browsers', () => {
const response = middleware(
request(DOCS_URL, { accept: 'text/html,application/xhtml+xml,*/*;q=0.8' })
)
assert.equal(response.status, 200)
assert.equal(response.headers.get('x-middleware-rewrite'), null)
})
})