Fumadocs Template

A documentation template built with Fumadocs for Tencent EdgeOne Pages.

Features

• MDX Support - Write documentation with Markdown and React components
• Type-Safe - Full TypeScript support with auto-generated types
• Built-in Search - Full-text search powered by Orama
• Dark Mode - Automatic dark mode support
• Performance - Optimized for speed with Next.js App Router
• EdgeOne Ready - Deploy seamlessly to Tencent EdgeOne Pages

Quick Start

Prerequisites

• Node.js 18 or later
• pnpm (recommended)

Installation

pnpm install

Development

pnpm dev

Open http://localhost:3000/docs to view the documentation.

Build

pnpm build

Project Structure

fumadocs-template/
├── content/           # MDX documentation files
│   └── docs/         # Documentation content
├── app/              # Next.js App Router
│   ├── docs/        # Docs pages (dynamic routing)
│   ├── api/         # API routes (search)
│   ├── layout.tsx   # Root layout
│   └── globals.css  # Global styles
├── lib/              # Utility libraries
│   ├── source.ts    # Data loader
│   └── layout.shared.tsx # Layout options
├── source.config.ts  # MDX configuration
├── next.config.mjs   # Next.js config with MDX
└── mdx-components.tsx # MDX components

Documentation

• Introduction - Overview of Fumadocs Template
• Quick Start - Get started quickly
• Configuration - Customize your docs
• Components - Built-in components
• Deploying - Deploy to EdgeOne Pages

One-Click Deploy

Click the button above to deploy this template directly to EdgeOne Pages.

Manual Deploy

1. Fork this repository
2. Go to EdgeOne Pages Console
3. Import your forked repository
4. Deploy!

Configuration

The edgeone.json file contains the deployment configuration:

{
  "buildCommand": "npm run build",
  "installCommand": "npm install",
  "framework": "nextjs"
}

Manual Build Settings (Alternative)

• Build Command: pnpm build
• Output Directory: .next

Tech Stack

• Next.js 15 - React framework
• Fumadocs - Documentation framework
• Tailwind CSS 4 - Styling
• TypeScript - Type safety

License

MIT