e5369f3a63
Replace the bespoke 16-section /docs page that pulled prose from
`messages/{locale}.json` with a build-time MDX renderer that reads the
canonical markdown in repo-root `docs/`. Each markdown file becomes
one section of the docs page, scrolled-to via the existing DocsShell
sidebar. Section data structure stays in `lib/docs-sections.ts` so the
sidebar / scroll-spy keeps working with no client changes.
Why this layout:
- One source of truth: `docs/guide/*.md`, `docs/reference/*.md`,
`docs/manifesto.md`. Edits land in one place; the website redeploys
pick them up automatically via the existing web-deploy workflow.
- Build-time only: `MDXRemote` is rendered inside an RSC and the page
is statically generated (`●` SSG). Cloudflare Workers serves the
rendered HTML; no MDX compiler runs at request time.
- next-intl unchanged for everything else: only the docs prose moves
out. `mobileHeader` and `searchPlaceholder` strings stay in
`messages/{locale}.json`; the 18 stale section keys are removed.
Files:
- web/lib/docs-sections.ts: 9 sections matching docs/ files, typed
`DocSection` with `{ id, title, file }`.
- web/lib/docs-source.ts: `loadDocSource(file)` reads
`<repo-root>/docs/<file>` at build time via `node:fs/promises`.
- web/components/docs/mdx-components.tsx: shadcn-styled overrides for
every markdown element (h1-h4, p, a, ul/ol/li, blockquote, code, pre,
table, hr, strong) so the rendered output matches the rest of the
site.
- web/app/[locale]/docs/page.tsx: rewritten as an async RSC that loads
every section's source in parallel and renders one MDXRemote per
section inside DocsShell.
- web/messages/{en,ja,ko,zh}.json: `docs` key trimmed from 20 entries
to 2 (mobileHeader, searchPlaceholder).
- web/package.json: + next-mdx-remote, + gray-matter.
Local verification: `bun run format:check`, `bun run lint`,
`bun run type-check`, `bun run build`, `bunx opennextjs-cloudflare
build` all pass; `/[locale]/docs` builds as static for all 4 locales
at 4.12 kB / 132 kB First Load.
141 lines
4.0 KiB
TypeScript
141 lines
4.0 KiB
TypeScript
import * as React from "react"
|
|
import { cn } from "@/lib/utils"
|
|
|
|
type WithChildren = { children?: React.ReactNode; className?: string }
|
|
|
|
export const mdxComponents = {
|
|
h1: ({ children, className, ...props }: WithChildren) => (
|
|
<h1
|
|
className={cn(
|
|
"mt-8 mb-4 scroll-mt-24 text-4xl font-bold tracking-tight first:mt-0",
|
|
className,
|
|
)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</h1>
|
|
),
|
|
h2: ({ children, className, ...props }: WithChildren) => (
|
|
<h2
|
|
className={cn("mt-12 mb-4 scroll-mt-24 text-2xl font-semibold tracking-tight", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</h2>
|
|
),
|
|
h3: ({ children, className, ...props }: WithChildren) => (
|
|
<h3
|
|
className={cn("mt-8 mb-3 scroll-mt-24 text-xl font-semibold tracking-tight", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</h3>
|
|
),
|
|
h4: ({ children, className, ...props }: WithChildren) => (
|
|
<h4
|
|
className={cn("mt-6 mb-2 scroll-mt-24 text-lg font-semibold tracking-tight", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</h4>
|
|
),
|
|
p: ({ children, className, ...props }: WithChildren) => (
|
|
<p className={cn("text-muted-foreground my-4 leading-7", className)} {...props}>
|
|
{children}
|
|
</p>
|
|
),
|
|
a: ({ children, href, className, ...props }: WithChildren & { href?: string }) => (
|
|
<a
|
|
href={href}
|
|
className={cn("text-primary font-medium underline underline-offset-4", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</a>
|
|
),
|
|
ul: ({ children, className, ...props }: WithChildren) => (
|
|
<ul className={cn("text-muted-foreground my-4 ml-6 list-disc space-y-1", className)} {...props}>
|
|
{children}
|
|
</ul>
|
|
),
|
|
ol: ({ children, className, ...props }: WithChildren) => (
|
|
<ol
|
|
className={cn("text-muted-foreground my-4 ml-6 list-decimal space-y-1", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</ol>
|
|
),
|
|
li: ({ children, className, ...props }: WithChildren) => (
|
|
<li className={cn("leading-7", className)} {...props}>
|
|
{children}
|
|
</li>
|
|
),
|
|
blockquote: ({ children, className, ...props }: WithChildren) => (
|
|
<blockquote
|
|
className={cn("border-primary/40 my-6 border-l-4 pl-4 italic", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</blockquote>
|
|
),
|
|
code: ({ children, className, ...props }: WithChildren) => (
|
|
<code
|
|
className={cn("bg-muted text-foreground rounded px-1.5 py-0.5 font-mono text-sm", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</code>
|
|
),
|
|
pre: ({ children, className, ...props }: WithChildren) => (
|
|
<pre
|
|
className={cn(
|
|
"border-border/50 my-4 overflow-x-auto rounded-lg border bg-[#1e1e2e] p-4 font-mono text-sm text-[#cdd6f4] shadow-sm [&_code]:bg-transparent [&_code]:p-0 [&_code]:text-inherit",
|
|
className,
|
|
)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</pre>
|
|
),
|
|
table: ({ children, className, ...props }: WithChildren) => (
|
|
<div className="my-6 overflow-x-auto">
|
|
<table
|
|
className={cn("border-border w-full border-collapse border text-sm", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</table>
|
|
</div>
|
|
),
|
|
thead: ({ children, className, ...props }: WithChildren) => (
|
|
<thead className={cn("bg-muted", className)} {...props}>
|
|
{children}
|
|
</thead>
|
|
),
|
|
th: ({ children, className, ...props }: WithChildren) => (
|
|
<th
|
|
className={cn("border-border border px-3 py-2 text-left font-semibold", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</th>
|
|
),
|
|
td: ({ children, className, ...props }: WithChildren) => (
|
|
<td
|
|
className={cn("border-border text-muted-foreground border px-3 py-2", className)}
|
|
{...props}
|
|
>
|
|
{children}
|
|
</td>
|
|
),
|
|
hr: ({ className, ...props }: { className?: string }) => (
|
|
<hr className={cn("border-border my-8", className)} {...props} />
|
|
),
|
|
strong: ({ children, className, ...props }: WithChildren) => (
|
|
<strong className={cn("text-foreground font-semibold", className)} {...props}>
|
|
{children}
|
|
</strong>
|
|
),
|
|
}
|