feat(docs): Scaffold new fumadocs documentation

wottpal · wottpal · commit 069d6698e5d8 · 2025-08-05T13:24:01.000+02:00
diff --git a/.changeset/huge-wolves-change.md b/.changeset/huge-wolves-change.md
@@ -0,0 +1,5 @@
+---
+'docs': major
+---
+
+Scaffold new standalone inkathon documentation under https://docs.inkathon.xyz
diff --git a/.changeset/plain-ducks-camp.md b/.changeset/plain-ducks-camp.md
@@ -0,0 +1,5 @@
+---
+'create-inkathon-app': patch
+---
+
+Remove new `docs` monorepo package
diff --git a/bun.lock b/bun.lock
diff --git a/create-inkathon-app/package.json b/create-inkathon-app/package.json
@@ -32,13 +32,13 @@
     "@inquirer/prompts": "^7.8.0",
     "commander": "^14.0.0",
     "picocolors": "^1.1.1",
-    "semver": "^7.6.3",
-    "snakecase-keys": "^8.1.0",
+    "semver": "^7.7.2",
+    "snakecase-keys": "^9.0.2",
     "yocto-spinner": "^1.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.17.0",
-    "@types/semver": "^7.5.8",
+    "@types/node": "^22.0.0",
+    "@types/semver": "^7.7.0",
     "typescript": "^5.9.2"
   },
   "keywords": [
diff --git a/create-inkathon-app/src/cleanup.ts b/create-inkathon-app/src/cleanup.ts
@@ -1,7 +1,7 @@
 import { readdir, rm } from "node:fs/promises"
 import { join } from "node:path"
 
-const DIRECTORIES_TO_REMOVE = [".changeset", ".github", "create-inkathon-app"]
+const DIRECTORIES_TO_REMOVE = [".changeset", ".github", "create-inkathon-app", "docs"]
 
 async function cleanupDirectories(projectPath: string): Promise<void> {
   for (const dir of DIRECTORIES_TO_REMOVE) {
diff --git a/create-inkathon-app/src/template.ts b/create-inkathon-app/src/template.ts
@@ -24,15 +24,12 @@ async function updatePackageJson(filePath: string, isRoot: boolean, name?: strin
   const pkg = JSON.parse(content)
 
   if (isRoot) {
-    // Update the name of the package only for root
-    if (name) {
-      pkg.name = name
-    }
+    // Update the name of the package
+    if (!name) throw new Error("Project name is required for root package.json")
+    pkg.name = name
 
-    // Remove create-inkathon-app from workspaces
-    if (pkg.workspaces && Array.isArray(pkg.workspaces)) {
-      pkg.workspaces = pkg.workspaces.filter((ws: string) => ws !== "create-inkathon-app")
-    }
+    // Only keep `frontend` & `contracts` workspaces
+    pkg.workspaces = ["frontend", "contracts"]
 
     // Clean up changeset-related items from root package.json
     if (pkg.scripts) {
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,28 @@
+# deps
+/node_modules
+
+# generated content
+.contentlayer
+.content-collections
+.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/docs/.prettierignore b/docs/.prettierignore
@@ -0,0 +1,18 @@
+node_modules
+package-lock.json
+pnpm-lock.yaml
+bun.lockb
+bun.lock
+yarn.lock
+
+LICENSE
+
+*.ts
+*.js
+*.tsx
+*.jsx
+*.cjs
+*.mjs
+*.json
+*.jsonc
+*.html
diff --git a/docs/.prettierrc.mjs b/docs/.prettierrc.mjs
@@ -0,0 +1,11 @@
+const prettierConfig = {
+  semi: false,
+  singleQuote: true,
+  trailingComma: "all",
+  printWidth: 100,
+  tabWidth: 2,
+  useTabs: false,
+  plugins: [],
+}
+
+export default prettierConfig
diff --git a/docs/content/docs/index.mdx b/docs/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.vercel.app" />
+</Cards>
diff --git a/docs/next.config.mjs b/docs/next.config.mjs
@@ -0,0 +1,26 @@
+import { createMDX } from "fumadocs-mdx/next"
+
+const withMDX = createMDX()
+
+/** @type {import('next').NextConfig} */
+const config = {
+  reactStrictMode: true,
+  // Biome
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+  typescript: {
+    ignoreBuildErrors: true,
+  },
+  // Images
+  images: {
+    remotePatterns: [
+      {
+        protocol: "https",
+        hostname: "inkathon.xyz",
+      },
+    ],
+  },
+}
+
+export default withMDX(config)
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,37 @@
+{
+  "name": "docs",
+  "version": "5.0.0",
+  "private": true,
+  "engines": {
+    "node": ">=20 <=22"
+  },
+  "engineStrict": true,
+  "scripts": {
+    "dev": "next dev --turbo",
+    "build": "next build --turbo",
+    "start": "next start",
+    "clean": "rm -rf .source .next tsconfig.tsbuildinfo",
+    "lint": "biome check . && prettier . --check",
+    "lint:fix": "biome check . --write && prettier . --write",
+    "typecheck": "tsc --pretty --noEmit",
+    "postinstall": "fumadocs-mdx"
+  },
+  "dependencies": {
+    "fumadocs-core": "15.6.9",
+    "fumadocs-mdx": "11.7.3",
+    "fumadocs-ui": "15.6.9",
+    "next": "15.4.5",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.1.11",
+    "@types/mdx": "^2.0.13",
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.1.9",
+    "@types/react-dom": "^19.1.7",
+    "postcss": "^8.5.6",
+    "tailwindcss": "^4.1.11",
+    "typescript": "^5.9.2"
+  }
+}
diff --git a/docs/postcss.config.mjs b/docs/postcss.config.mjs
@@ -0,0 +1,5 @@
+export default {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+}
diff --git a/docs/source.config.ts b/docs/source.config.ts
@@ -0,0 +1,18 @@
+import { defineConfig, defineDocs, frontmatterSchema, metaSchema } from "fumadocs-mdx/config"
+
+// You can customise Zod schemas for frontmatter and `meta.json` here
+// see https://fumadocs.vercel.app/docs/mdx/collections#define-docs
+export const docs = defineDocs({
+  docs: {
+    schema: frontmatterSchema,
+  },
+  meta: {
+    schema: metaSchema,
+  },
+})
+
+export default defineConfig({
+  mdxOptions: {
+    // MDX options
+  },
+})
diff --git a/docs/src/app/(docs)/[[...slug]]/page.tsx b/docs/src/app/(docs)/[[...slug]]/page.tsx
@@ -0,0 +1,43 @@
+import { createRelativeLink } from "fumadocs-ui/mdx"
+import { DocsBody, DocsDescription, DocsPage, DocsTitle } from "fumadocs-ui/page"
+import { notFound } from "next/navigation"
+import { source } from "@/lib/source"
+import { getMDXComponents } from "@/mdx-components"
+
+export default async function Page(props: { params: Promise<{ slug?: string[] }> }) {
+  const params = await props.params
+  const page = source.getPage(params.slug)
+  if (!page) notFound()
+
+  const MDXContent = page.data.body
+
+  return (
+    <DocsPage toc={page.data.toc} full={page.data.full}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDXContent
+          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: { params: Promise<{ slug?: string[] }> }) {
+  const params = await props.params
+  const page = source.getPage(params.slug)
+  if (!page) notFound()
+
+  return {
+    title: page.data.title,
+    description: page.data.description,
+  }
+}
diff --git a/docs/src/app/(docs)/layout.tsx b/docs/src/app/(docs)/layout.tsx
@@ -0,0 +1,12 @@
+import { DocsLayout } from "fumadocs-ui/layouts/docs"
+import type { ReactNode } from "react"
+import { baseOptions } from "@/app/layout.config"
+import { source } from "@/lib/source"
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <DocsLayout tree={source.pageTree} {...baseOptions}>
+      {children}
+    </DocsLayout>
+  )
+}
diff --git a/docs/src/app/api/search/route.ts b/docs/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/open-source/supported-languages
+  language: "english",
+})
diff --git a/docs/src/app/apple-touch-icon.png b/docs/src/app/apple-touch-icon.png
diff --git a/docs/src/app/favicon.ico b/docs/src/app/favicon.ico
diff --git a/docs/src/app/global.css b/docs/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/docs/src/app/layout.config.tsx b/docs/src/app/layout.config.tsx
@@ -0,0 +1,28 @@
+import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared"
+import Image from "next/image"
+
+/**
+ * Shared layout configurations
+ *
+ * you can customise layouts individually from:
+ * Home Layout: app/(home)/layout.tsx
+ * Docs Layout: app/docs/layout.tsx
+ */
+export const baseOptions: BaseLayoutProps = {
+  nav: {
+    title: (
+      <>
+        <Image
+          src="https://inkathon.xyz/inkathon-icon.png"
+          alt="inkathon Logo"
+          width={20}
+          height={20}
+          priority
+        />
+        inkathon
+      </>
+    ),
+  },
+  // see https://fumadocs.dev/docs/ui/navigation/links
+  links: [],
+}
diff --git a/docs/src/app/layout.tsx b/docs/src/app/layout.tsx
@@ -0,0 +1,18 @@
+import "@/app/global.css"
+import { RootProvider } from "fumadocs-ui/provider"
+import { Inter } from "next/font/google"
+import type { ReactNode } from "react"
+
+const inter = Inter({
+  subsets: ["latin"],
+})
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <html lang="en" className={inter.className} suppressHydrationWarning>
+      <body className="flex min-h-screen flex-col">
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  )
+}
diff --git a/docs/src/app/web-app-manifest-512x512.png b/docs/src/app/web-app-manifest-512x512.png
diff --git a/docs/src/lib/source.ts b/docs/src/lib/source.ts
@@ -0,0 +1,9 @@
+import { loader } from "fumadocs-core/source"
+import { docs } from "@/.source"
+
+// See https://fumadocs.vercel.app/docs/headless/source-api for more info
+export const source = loader({
+  // it assigns a URL to your pages
+  baseUrl: "/",
+  source: docs.toFumadocsSource(),
+})
diff --git a/docs/src/mdx-components.tsx b/docs/src/mdx-components.tsx
@@ -0,0 +1,10 @@
+import defaultMdxComponents from "fumadocs-ui/mdx"
+import type { MDXComponents } from "mdx/types"
+
+// use this function to get MDX components, you will need it for rendering MDX
+export function getMDXComponents(components?: MDXComponents): MDXComponents {
+  return {
+    ...defaultMdxComponents,
+    ...components,
+  }
+}
diff --git a/docs/tsconfig.json b/docs/tsconfig.json
@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "target": "ESNext",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "paths": {
+      "@/.source": ["./.source/index.ts"],
+      "@/*": ["./src/*"]
+    },
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/docs/vercel.json b/docs/vercel.json
diff --git a/frontend/package.json b/frontend/package.json
diff --git a/package.json b/package.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'docs': major
 +---
++
 +Scaffold new standalone inkathon documentation under https://docs.inkathon.xyz