This is a documentation site built with Fumadocs and Next.js. Fumadocs is a modern documentation framework that provides a beautiful, responsive, and feature-rich documentation experience.
- Built on Next.js App Router
- MDX support for rich content
- Built-in search functionality
- Responsive navigation
- Dark/light mode
- Code highlighting
Run the development server:
npm run dev
# or
pnpm dev
# or
yarn dev
Open http://localhost:3000 with your browser to see the documentation site.
lib/source.ts
: Code for content source adapter,loader()
provides the interface to access your content.app/layout.config.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. |
A source.config.ts
config file has been included, you can customise different options like frontmatter schema.
Read the Introduction for further details.
To learn more about Next.js and Fumadocs, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
- Fumadocs - learn about Fumadocs