feat: add fumadocs documentation app

kWAYTV · kWAYTV · commit d376d5026169 · 2025-11-26T09:01:09.000+01:00
diff --git a/apps/fumadocs/.gitignore b/apps/fumadocs/.gitignore
@@ -0,0 +1,26 @@
+# deps
+/node_modules
+
+# generated content
+.source
+
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
+
+# misc
+.DS_Store
+*.pem
+/.pnp
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts
diff --git a/apps/fumadocs/README.md b/apps/fumadocs/README.md
@@ -0,0 +1,45 @@
+# fumadocs
+
+This is a Next.js application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
+
+Run development server:
+
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
+```
+
+Open http://localhost:3000 with your browser to see the result.
+
+## Explore
+
+In the project, you can see:
+
+- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
+- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
+
+| Route                     | Description                                            |
+| ------------------------- | ------------------------------------------------------ |
+| `app/(home)`              | The route group for your landing page and other pages. |
+| `app/docs`                | The documentation layout and pages.                    |
+| `app/api/search/route.ts` | The Route Handler for search.                          |
+
+### Fumadocs MDX
+
+A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
+
+Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
+
+## Learn More
+
+To learn more about Next.js and Fumadocs, take a look at the following
+resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.dev) - learn about Fumadocs
diff --git a/apps/fumadocs/content/docs/index.mdx b/apps/fumadocs/content/docs/index.mdx
@@ -0,0 +1,13 @@
+---
+title: Hello World
+description: Your first document
+---
+
+Welcome to the docs! You can start writing documents in `/content/docs`.
+
+## What is Next?
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
+</Cards>
diff --git a/apps/fumadocs/content/docs/test.mdx b/apps/fumadocs/content/docs/test.mdx
@@ -0,0 +1,17 @@
+---
+title: Components
+description: Components
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
+</Cards>
diff --git a/apps/fumadocs/next.config.mjs b/apps/fumadocs/next.config.mjs
@@ -0,0 +1,11 @@
+import { createMDX } from "fumadocs-mdx/next";
+
+const withMDX = createMDX();
+
+/** @type {import('next').NextConfig} */
+const config = {
+  reactStrictMode: true,
+  devIndicators: false,
+};
+
+export default withMDX(config);
diff --git a/apps/fumadocs/package.json b/apps/fumadocs/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "fumadocs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "build": "next build",
+    "dev": "next dev --port=3001",
+    "start": "next start",
+    "types:check": "fumadocs-mdx && tsc --noEmit",
+    "postinstall": "fumadocs-mdx"
+  },
+  "dependencies": {
+    "fumadocs-core": "16.1.0",
+    "fumadocs-mdx": "14.0.3",
+    "fumadocs-ui": "16.1.0",
+    "lucide-react": "^0.552.0",
+    "next": "16.0.1",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.1.16",
+    "@types/mdx": "^2.0.13",
+    "@types/node": "^24.10.0",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "postcss": "^8.5.6",
+    "tailwindcss": "^4.1.16",
+    "typescript": "^5.9.3"
+  }
+}
diff --git a/apps/fumadocs/postcss.config.mjs b/apps/fumadocs/postcss.config.mjs
@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
diff --git a/apps/fumadocs/source.config.ts b/apps/fumadocs/source.config.ts
@@ -0,0 +1,27 @@
+import {
+  defineConfig,
+  defineDocs,
+  frontmatterSchema,
+  metaSchema,
+} from "fumadocs-mdx/config";
+
+// You can customise Zod schemas for frontmatter and `meta.json` here
+// see https://fumadocs.dev/docs/mdx/collections
+export const docs = defineDocs({
+  dir: "content/docs",
+  docs: {
+    schema: frontmatterSchema,
+    postprocess: {
+      includeProcessedMarkdown: true,
+    },
+  },
+  meta: {
+    schema: metaSchema,
+  },
+});
+
+export default defineConfig({
+  mdxOptions: {
+    // MDX options
+  },
+});
diff --git a/apps/fumadocs/src/app/(home)/layout.tsx b/apps/fumadocs/src/app/(home)/layout.tsx
@@ -0,0 +1,6 @@
+import { HomeLayout } from "fumadocs-ui/layouts/home";
+import { baseOptions } from "@/lib/layout.shared";
+
+export default function Layout({ children }: LayoutProps<"/">) {
+  return <HomeLayout {...baseOptions()}>{children}</HomeLayout>;
+}
diff --git a/apps/fumadocs/src/app/(home)/page.tsx b/apps/fumadocs/src/app/(home)/page.tsx
@@ -0,0 +1,16 @@
+import Link from "next/link";
+
+export default function HomePage() {
+  return (
+    <div className="flex flex-1 flex-col justify-center text-center">
+      <h1 className="mb-4 font-bold text-2xl">Hello World</h1>
+      <p>
+        You can open{" "}
+        <Link className="font-medium underline" href="/docs">
+          /docs
+        </Link>{" "}
+        and see the documentation.
+      </p>
+    </div>
+  );
+}
diff --git a/apps/fumadocs/src/app/api/search/route.ts b/apps/fumadocs/src/app/api/search/route.ts
@@ -0,0 +1,7 @@
+import { createFromSource } from "fumadocs-core/search/server";
+import { source } from "@/lib/source";
+
+export const { GET } = createFromSource(source, {
+  // https://docs.orama.com/docs/orama-js/supported-languages
+  language: "english",
+});
diff --git a/apps/fumadocs/src/app/docs/[[...slug]]/page.tsx b/apps/fumadocs/src/app/docs/[[...slug]]/page.tsx
@@ -0,0 +1,60 @@
+import { getPageImage, source } from "@/lib/source";
+import { getMDXComponents } from "@/mdx-components";
+import { createRelativeLink } from "fumadocs-ui/mdx";
+import {
+  DocsBody,
+  DocsDescription,
+  DocsPage,
+  DocsTitle,
+} from "fumadocs-ui/page";
+import type { Metadata } from "next";
+import { notFound } from "next/navigation";
+
+type PageProps = {
+  params: Promise<{ slug?: string[] }>;
+};
+
+export default async function Page(props: PageProps) {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+  if (!page) {
+    notFound();
+  }
+
+  const MDX = page.data.body;
+
+  return (
+    <DocsPage full={page.data.full} toc={page.data.toc}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDX
+          components={getMDXComponents({
+            // this allows you to link to other pages with relative file paths
+            a: createRelativeLink(source, page),
+          })}
+        />
+      </DocsBody>
+    </DocsPage>
+  );
+}
+
+export async function generateStaticParams() {
+  return source.generateParams();
+}
+
+export async function generateMetadata(props: PageProps): Promise<Metadata> {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+  if (!page) {
+    notFound();
+  }
+
+  return {
+    title: page.data.title,
+    description: page.data.description,
+    openGraph: {
+      images: getPageImage(page).url,
+    },
+  };
+}
diff --git a/apps/fumadocs/src/app/docs/layout.tsx b/apps/fumadocs/src/app/docs/layout.tsx
@@ -0,0 +1,11 @@
+import { DocsLayout } from "fumadocs-ui/layouts/docs";
+import { baseOptions } from "@/lib/layout.shared";
+import { source } from "@/lib/source";
+
+export default function Layout({ children }: LayoutProps<"/docs">) {
+  return (
+    <DocsLayout tree={source.pageTree} {...baseOptions()}>
+      {children}
+    </DocsLayout>
+  );
+}
diff --git a/apps/fumadocs/src/app/favicon.ico b/apps/fumadocs/src/app/favicon.ico
diff --git a/apps/fumadocs/src/app/global.css b/apps/fumadocs/src/app/global.css
@@ -0,0 +1,3 @@
+@import "tailwindcss";
+@import "fumadocs-ui/css/neutral.css";
+@import "fumadocs-ui/css/preset.css";
diff --git a/apps/fumadocs/src/app/layout.tsx b/apps/fumadocs/src/app/layout.tsx
@@ -0,0 +1,17 @@
+import { RootProvider } from "fumadocs-ui/provider/next";
+import "./global.css";
+import { Inter } from "next/font/google";
+
+const inter = Inter({
+  subsets: ["latin"],
+});
+
+export default function Layout({ children }: LayoutProps<"/">) {
+  return (
+    <html className={inter.className} lang="en" suppressHydrationWarning>
+      <body className="flex min-h-screen flex-col">
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  );
+}
diff --git a/apps/fumadocs/src/app/llms-full.txt/route.ts b/apps/fumadocs/src/app/llms-full.txt/route.ts
@@ -0,0 +1,10 @@
+import { getLLMText, source } from "@/lib/source";
+
+export const revalidate = false;
+
+export async function GET() {
+  const scan = source.getPages().map(getLLMText);
+  const scanned = await Promise.all(scan);
+
+  return new Response(scanned.join("\n\n"));
+}
diff --git a/apps/fumadocs/src/app/og/docs/[...slug]/route.tsx b/apps/fumadocs/src/app/og/docs/[...slug]/route.tsx
@@ -0,0 +1,37 @@
+import { generate as DefaultImage } from "fumadocs-ui/og";
+import { notFound } from "next/navigation";
+import { ImageResponse } from "next/og";
+import { getPageImage, source } from "@/lib/source";
+
+type RouteContext = {
+  params: Promise<{ slug: string[] }>;
+};
+
+export const revalidate = false;
+
+export async function GET(_req: Request, { params }: RouteContext) {
+  const { slug } = await params;
+  const page = source.getPage(slug.slice(0, -1));
+  if (!page) {
+    notFound();
+  }
+
+  return new ImageResponse(
+    <DefaultImage
+      description={page.data.description}
+      site="My App"
+      title={page.data.title}
+    />,
+    {
+      width: 1200,
+      height: 630,
+    }
+  );
+}
+
+export function generateStaticParams() {
+  return source.getPages().map((page) => ({
+    lang: page.locale,
+    slug: getPageImage(page).segments,
+  }));
+}
diff --git a/apps/fumadocs/src/lib/layout.shared.tsx b/apps/fumadocs/src/lib/layout.shared.tsx
@@ -0,0 +1,9 @@
+import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
+
+export function baseOptions(): BaseLayoutProps {
+  return {
+    nav: {
+      title: "My App",
+    },
+  };
+}
diff --git a/apps/fumadocs/src/lib/source.ts b/apps/fumadocs/src/lib/source.ts
@@ -0,0 +1,27 @@
+import { docs } from "fumadocs-mdx:collections/server";
+import { type InferPageType, loader } from "fumadocs-core/source";
+import { lucideIconsPlugin } from "fumadocs-core/source/lucide-icons";
+
+// See https://fumadocs.dev/docs/headless/source-api for more info
+export const source = loader({
+  baseUrl: "/docs",
+  source: docs.toFumadocsSource(),
+  plugins: [lucideIconsPlugin()],
+});
+
+export function getPageImage(page: InferPageType<typeof source>) {
+  const segments = [...page.slugs, "image.png"];
+
+  return {
+    segments,
+    url: `/og/docs/${segments.join("/")}`,
+  };
+}
+
+export async function getLLMText(page: InferPageType<typeof source>) {
+  const processed = await page.data.getText("processed");
+
+  return `# ${page.data.title}
+
+${processed}`;
+}
diff --git a/apps/fumadocs/src/mdx-components.tsx b/apps/fumadocs/src/mdx-components.tsx
diff --git a/apps/fumadocs/tsconfig.json b/apps/fumadocs/tsconfig.json
diff --git a/bts.jsonc b/bts.jsonc
diff --git a/bun.lock b/bun.lock
