npm - create-fumadocs-app - Versions diffs - 16.0.0 → 16.0.2 - Mend

create-fumadocs-app 16.0.0 → 16.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

package/template/+orama-cloud/tanstack-start/src/routes/__root.tsx ADDED Viewed

@@ -0,0 +1,51 @@
+import {
+  createRootRoute,
+  HeadContent,
+  Outlet,
+  Scripts,
+} from '@tanstack/react-router';
+import * as React from 'react';
+import appCss from '@/styles/app.css?url';
+import { RootProvider } from 'fumadocs-ui/provider/tanstack';
+import SearchDialog from '@/components/search';
+export const Route = createRootRoute({
+  head: () => ({
+    meta: [
+      {
+        charSet: 'utf-8',
+      },
+      {
+        name: 'viewport',
+        content: 'width=device-width, initial-scale=1',
+      },
+      {
+        title: 'Fumadocs on TanStack Start',
+      },
+    ],
+    links: [{ rel: 'stylesheet', href: appCss }],
+  }),
+  component: RootComponent,
+});
+function RootComponent() {
+  return (
+    <RootDocument>
+      <Outlet />
+    </RootDocument>
+  );
+}
+function RootDocument({ children }: { children: React.ReactNode }) {
+  return (
+    <html suppressHydrationWarning>
+      <head>
+        <HeadContent />
+      </head>
+      <body className="flex flex-col min-h-screen">
+        <RootProvider search={{ SearchDialog }}>{children}</RootProvider>
+        <Scripts />
+      </body>
+    </html>
+  );
+}

package/template/+orama-cloud/tanstack-start/src/routes/static[.]json.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { createFileRoute } from '@tanstack/react-router';
+import { exportSearchIndexes } from '@/lib/export-search-indexes';
+export const Route = createFileRoute('/static.json')({
+  server: {
+    handlers: {
+      GET: async () => Response.json(await exportSearchIndexes()),
+    },
+  },
+});

package/template/+orama-cloud/tanstack-start/vite.config.ts ADDED Viewed

@@ -0,0 +1,27 @@
+import react from '@vitejs/plugin-react';
+import { tanstackStart } from '@tanstack/react-start/plugin/vite';
+import { defineConfig } from 'vite';
+import tsConfigPaths from 'vite-tsconfig-paths';
+import tailwindcss from '@tailwindcss/vite';
+import mdx from 'fumadocs-mdx/vite';
+export default defineConfig({
+  server: {
+    port: 3000,
+  },
+  plugins: [
+    mdx(await import('./source.config')),
+    tailwindcss(),
+    tsConfigPaths({
+      projects: ['./tsconfig.json'],
+    }),
+    tanstackStart({
+      prerender: {
+        enabled: true,
+        // pre-render the static file
+        pages: [{ path: '/static.json' }],
+      },
+    }),
+    react(),
+  ],
+});

package/template/+orama-cloud/waku/src/components/provider.tsx ADDED Viewed

@@ -0,0 +1,8 @@
+'use client';
+import type { ReactNode } from 'react';
+import { RootProvider } from 'fumadocs-ui/provider/waku';
+import SearchDialog from '@/components/search';
+export function Provider({ children }: { children: ReactNode }) {
+  return <RootProvider search={{ SearchDialog }}>{children}</RootProvider>;
+}

package/template/+orama-cloud/waku/src/pages/api/static.json.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { exportSearchIndexes } from '@/lib/export-search-indexes';
+export async function GET() {
+  return Response.json(await exportSearchIndexes());
+}
+export const getConfig = () => ({
+  render: 'static',
+});

package/template/react-router/app/docs/page.tsx CHANGED Viewed

@@ -7,11 +7,11 @@ import {
   DocsTitle,
 } from 'fumadocs-ui/page';
 import { source } from '@/lib/source';
-import { baseOptions } from '@/lib/layout.shared';
 import type * as PageTree from 'fumadocs-core/page-tree';
 import defaultMdxComponents from 'fumadocs-ui/mdx';
 import { docs } from '@/.source';
 import { toClientRenderer } from 'fumadocs-mdx/runtime/vite';
+import { baseOptions } from '@/lib/layout.shared';
 export async function loader({ params }: Route.LoaderArgs) {
   const slugs = params['*'].split('/').filter((v) => v.length > 0);
@@ -20,7 +20,7 @@ export async function loader({ params }: Route.LoaderArgs) {
   return {
     path: page.path,
-    tree: source.pageTree,
+    tree: source.getPageTree(),
   };
 }
@@ -41,8 +41,8 @@ const renderer = toClientRenderer(
   },
 );
-export default function Page(props: Route.ComponentProps) {
-  const { tree, path } = props.loaderData;
+export default function Page({ loaderData }: Route.ComponentProps) {
+  const { tree, path } = loaderData;
   const Content = renderer[path];
   return (

package/template/react-router/example.gitignore CHANGED Viewed

@@ -4,5 +4,4 @@
 # React Router
 /.react-router/
 /build/
 .source

package/template/react-router-spa/README.md ADDED Viewed

@@ -0,0 +1,12 @@
+This is a React Router application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
+Run development server:
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn dev
+```

package/template/react-router-spa/app/app.css ADDED Viewed

@@ -0,0 +1,3 @@
+@import 'tailwindcss';
+@import 'fumadocs-ui/css/neutral.css';
+@import 'fumadocs-ui/css/preset.css';

package/template/react-router-spa/app/components/search.tsx ADDED Viewed

@@ -0,0 +1,50 @@
+'use client';
+import {
+  SearchDialog,
+  SearchDialogClose,
+  SearchDialogContent,
+  SearchDialogHeader,
+  SearchDialogIcon,
+  SearchDialogInput,
+  SearchDialogList,
+  SearchDialogOverlay,
+  type SharedProps,
+} from 'fumadocs-ui/components/dialog/search';
+import { useDocsSearch } from 'fumadocs-core/search/client';
+import { create } from '@orama/orama';
+import { useI18n } from 'fumadocs-ui/contexts/i18n';
+function initOrama() {
+  return create({
+    schema: { _: 'string' },
+    language: 'english',
+  });
+}
+export default function DefaultSearchDialog(props: SharedProps) {
+  const { locale } = useI18n();
+  const { search, setSearch, query } = useDocsSearch({
+    type: 'static',
+    initOrama,
+    locale,
+  });
+  return (
+    <SearchDialog
+      search={search}
+      onSearchChange={setSearch}
+      isLoading={query.isLoading}
+      {...props}
+    >
+      <SearchDialogOverlay />
+      <SearchDialogContent>
+        <SearchDialogHeader>
+          <SearchDialogIcon />
+          <SearchDialogInput />
+          <SearchDialogClose />
+        </SearchDialogHeader>
+        <SearchDialogList items={query.data !== 'empty' ? query.data : null} />
+      </SearchDialogContent>
+    </SearchDialog>
+  );
+}

package/template/react-router-spa/app/docs/page.tsx ADDED Viewed

@@ -0,0 +1,53 @@
+import type { Route } from './+types/page';
+import { DocsLayout } from 'fumadocs-ui/layouts/docs';
+import {
+  DocsBody,
+  DocsDescription,
+  DocsPage,
+  DocsTitle,
+} from 'fumadocs-ui/page';
+import { source } from '@/lib/source';
+import type * as PageTree from 'fumadocs-core/page-tree';
+import defaultMdxComponents from 'fumadocs-ui/mdx';
+import { docs } from '@/.source';
+import { toClientRenderer } from 'fumadocs-mdx/runtime/vite';
+import { baseOptions } from '@/lib/layout.shared';
+export async function loader({ params }: Route.LoaderArgs) {
+  const slugs = params['*'].split('/').filter((v) => v.length > 0);
+  const page = source.getPage(slugs);
+  if (!page) throw new Response('Not found', { status: 404 });
+  return {
+    path: page.path,
+    tree: source.getPageTree(),
+  };
+}
+const renderer = toClientRenderer(
+  docs.doc,
+  ({ toc, default: Mdx, frontmatter }) => {
+    return (
+      <DocsPage toc={toc}>
+        <title>{frontmatter.title}</title>
+        <meta name="description" content={frontmatter.description} />
+        <DocsTitle>{frontmatter.title}</DocsTitle>
+        <DocsDescription>{frontmatter.description}</DocsDescription>
+        <DocsBody>
+          <Mdx components={{ ...defaultMdxComponents }} />
+        </DocsBody>
+      </DocsPage>
+    );
+  },
+);
+export default function Page({ loaderData }: Route.ComponentProps) {
+  const { tree, path } = loaderData;
+  const Content = renderer[path];
+  return (
+    <DocsLayout {...baseOptions()} tree={tree as PageTree.Root}>
+      <Content />
+    </DocsLayout>
+  );
+}

package/template/react-router-spa/app/docs/search.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { createFromSource } from 'fumadocs-core/search/server';
+import { source } from '@/lib/source';
+const server = createFromSource(source, {
+  language: 'english',
+});
+export async function loader() {
+  return server.staticGET();
+}

package/template/react-router-spa/app/lib/layout.shared.tsx ADDED Viewed

@@ -0,0 +1,9 @@
+import type { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
+export function baseOptions(): BaseLayoutProps {
+  return {
+    nav: {
+      title: 'React Router',
+    },
+  };
+}

package/template/react-router-spa/app/lib/source.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { loader } from 'fumadocs-core/source';
+import { create, docs } from '@/.source';
+export const source = loader({
+  source: await create.sourceAsync(docs.doc, docs.meta),
+  baseUrl: '/docs',
+});

package/template/react-router-spa/app/root.tsx ADDED Viewed

@@ -0,0 +1,76 @@
+import {
+  isRouteErrorResponse,
+  Links,
+  Meta,
+  Outlet,
+  Scripts,
+  ScrollRestoration,
+} from 'react-router';
+import { RootProvider } from 'fumadocs-ui/provider/react-router';
+import type { Route } from './+types/root';
+import './app.css';
+import SearchDialog from '@/components/search';
+export const links: Route.LinksFunction = () => [
+  { rel: 'preconnect', href: 'https://fonts.googleapis.com' },
+  {
+    rel: 'preconnect',
+    href: 'https://fonts.gstatic.com',
+    crossOrigin: 'anonymous',
+  },
+  {
+    rel: 'stylesheet',
+    href: 'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap',
+  },
+];
+export function Layout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en" suppressHydrationWarning>
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+      </head>
+      <body className="flex flex-col min-h-screen">
+        <RootProvider search={{ SearchDialog }}>{children}</RootProvider>
+        <ScrollRestoration />
+        <Scripts />
+      </body>
+    </html>
+  );
+}
+export default function App() {
+  return <Outlet />;
+}
+export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
+  let message = 'Oops!';
+  let details = 'An unexpected error occurred.';
+  let stack: string | undefined;
+  if (isRouteErrorResponse(error)) {
+    message = error.status === 404 ? '404' : 'Error';
+    details =
+      error.status === 404
+        ? 'The requested page could not be found.'
+        : error.statusText || details;
+  } else if (import.meta.env.DEV && error && error instanceof Error) {
+    details = error.message;
+    stack = error.stack;
+  }
+  return (
+    <main className="pt-16 p-4 container mx-auto">
+      <h1>{message}</h1>
+      <p>{details}</p>
+      {stack && (
+        <pre className="w-full p-4 overflow-x-auto">
+          <code>{stack}</code>
+        </pre>
+      )}
+    </main>
+  );
+}

package/template/react-router-spa/app/routes/home.tsx ADDED Viewed

@@ -0,0 +1,30 @@
+import type { Route } from './+types/home';
+import { HomeLayout } from 'fumadocs-ui/layouts/home';
+import { Link } from 'react-router';
+import { baseOptions } from '@/lib/layout.shared';
+export function meta({}: Route.MetaArgs) {
+  return [
+    { title: 'New React Router App' },
+    { name: 'description', content: 'Welcome to React Router!' },
+  ];
+}
+export default function Home() {
+  return (
+    <HomeLayout {...baseOptions()}>
+      <div className="p-4 flex flex-col items-center justify-center text-center flex-1">
+        <h1 className="text-xl font-bold mb-2">Fumadocs on React Router.</h1>
+        <p className="text-fd-muted-foreground mb-4">
+          The truly flexible docs framework on React.js.
+        </p>
+        <Link
+          className="text-sm bg-fd-primary text-fd-primary-foreground rounded-full font-medium px-4 py-2.5"
+          to="/docs"
+        >
+          Open Docs
+        </Link>
+      </div>
+    </HomeLayout>
+  );
+}

package/template/react-router-spa/app/routes.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { index, route, type RouteConfig } from '@react-router/dev/routes';
+export default [
+  index('routes/home.tsx'),
+  route('docs/*', 'docs/page.tsx'),
+  route('api/search', 'docs/search.ts'),
+] satisfies RouteConfig;

package/template/react-router-spa/content/docs/index.mdx ADDED Viewed

@@ -0,0 +1,32 @@
+---
+title: Hello World
+description: |
+  Your first `document`
+  You'll love it!
+---
+Hey there! Fumadocs is the docs framework that also works on React Router!
+## Heading
+Hello World
+<Cards>
+  <Card title="Learn more about React Router" href="https://reactrouter.com" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
+</Cards>
+```ts
+console.log('I love React!');
+```
+### Heading
+#### Heading
+| Head                            | Description                         |
+| ------------------------------- | ----------------------------------- |
+| `hello`                         | Hello World                         |
+| very **important**              | Hey                                 |
+| _Surprisingly_                  | Fumadocs                            |
+| very long text that looks weird | hello world hello world hello world |

package/template/react-router-spa/content/docs/test.mdx ADDED Viewed

@@ -0,0 +1,24 @@
+---
+title: Test
+description: A document to test Fumadocs
+---
+Hey there!
+## 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>
+### CodeBlock
+```js
+console.log('Hello World');
+```
+#### List
+- Hello
+- World

package/template/react-router-spa/example.gitignore ADDED Viewed

@@ -0,0 +1,7 @@
+.DS_Store
+/node_modules/
+# React Router
+/.react-router/
+/build/
+.source

package/template/react-router-spa/package.json ADDED Viewed

@@ -0,0 +1,36 @@
+{
+  "name": "example-react-router-spa",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "react-router build",
+    "dev": "react-router dev",
+    "start": "serve ./build/client",
+    "typecheck": "react-router typegen && tsc"
+  },
+  "dependencies": {
+    "@orama/orama": "^3.1.16",
+    "@react-router/node": "^7.9.4",
+    "fumadocs-core": "workspace:*",
+    "fumadocs-mdx": "workspace:*",
+    "fumadocs-ui": "workspace:*",
+    "isbot": "^5.1.31",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "react-router": "^7.9.4"
+  },
+  "devDependencies": {
+    "serve": "^14.2.5",
+    "@react-router/dev": "^7.9.4",
+    "@tailwindcss/vite": "^4.1.15",
+    "@types/mdx": "^2.0.13",
+    "@types/node": "^24.9.1",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "react-router-devtools": "^5.1.3",
+    "tailwindcss": "^4.1.15",
+    "typescript": "^5.9.3",
+    "vite": "^7.1.11",
+    "vite-tsconfig-paths": "^5.1.4"
+  }
+}

package/template/react-router-spa/public/favicon.ico ADDED Viewed

Binary file

package/template/react-router-spa/react-router.config.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import type { Config } from '@react-router/dev/config';
+import { glob } from 'node:fs/promises';
+import { createGetUrl, getSlugs } from 'fumadocs-core/source';
+const getUrl = createGetUrl('/docs');
+export default {
+  ssr: false,
+  async prerender({ getStaticPaths }) {
+    const paths: string[] = [...getStaticPaths()];
+    for await (const entry of glob('**/*.mdx', { cwd: 'content/docs' })) {
+      paths.push(getUrl(getSlugs(entry)));
+    }
+    return paths;
+  },
+} satisfies Config;

package/template/react-router-spa/serve.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+  "rewrites": [{ "source": "/**", "destination": "/index.html" }]
+}

package/template/react-router-spa/source.config.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { defineConfig, defineDocs } from 'fumadocs-mdx/config';
+export const docs = defineDocs({
+  dir: 'content/docs',
+});
+export default defineConfig();

package/template/react-router-spa/tsconfig.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "include": [
+    "**/*",
+    "**/.server/**/*",
+    "**/.client/**/*",
+    ".react-router/types/**/*"
+  ],
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ES2022"],
+    "types": ["node", "vite/client"],
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "rootDirs": [".", "./.react-router/types"],
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./app/*"],
+      "@/.source": [".source"]
+    },
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true
+  }
+}

package/template/react-router-spa/vite.config.ts ADDED Viewed

@@ -0,0 +1,10 @@
+import { reactRouter } from '@react-router/dev/vite';
+import tailwindcss from '@tailwindcss/vite';
+import { defineConfig } from 'vite';
+import tsconfigPaths from 'vite-tsconfig-paths';
+import mdx from 'fumadocs-mdx/vite';
+import * as MdxConfig from './source.config';
+export default defineConfig({
+  plugins: [mdx(MdxConfig), tailwindcss(), reactRouter(), tsconfigPaths()],
+});

package/template/tanstack-start/example.gitignore CHANGED Viewed

@@ -6,6 +6,14 @@ node_modules
 .output
 .nitro
 /build/
+/api/
+/server/build
+/public/build
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
 .tanstack
+src/routeTree.gen.ts
 .source

package/template/tanstack-start/package.json CHANGED Viewed

@@ -9,9 +9,9 @@
     "start": "node .output/server/index.mjs"
   },
   "dependencies": {
-    "@tanstack/react-router": "^1.133.15",
-    "@tanstack/react-router-devtools": "^1.133.15",
-    "@tanstack/react-start": "^1.133.15",
+    "@tanstack/react-router": "^1.133.21",
+    "@tanstack/react-router-devtools": "^1.133.21",
+    "@tanstack/react-start": "^1.133.21",
     "fumadocs-core": "workspace:*",
     "fumadocs-mdx": "workspace:*",
     "fumadocs-ui": "workspace:*",
@@ -22,13 +22,13 @@
     "vite": "^7.1.11"
   },
   "devDependencies": {
-    "@tailwindcss/vite": "^4.1.14",
+    "@tailwindcss/vite": "^4.1.15",
     "@types/mdx": "^2.0.13",
-    "@types/node": "^24.8.1",
+    "@types/node": "^24.9.1",
     "@types/react": "^19.2.2",
     "@types/react-dom": "^19.2.2",
     "@vitejs/plugin-react": "^5.0.4",
-    "tailwindcss": "^4.1.14",
+    "tailwindcss": "^4.1.15",
     "typescript": "^5.9.3",
     "vite-tsconfig-paths": "^5.1.4"
   }

package/template/waku/example.gitignore CHANGED Viewed

@@ -1,4 +1,6 @@
 .DS_Store
 /node_modules/
+dist
 .source
-dist
+src/pages.gen.ts