Getting Started
Create your documentation site in a few minutes: create the project, install the dependencies, start the dev server and write your first page.
Create the project
Use the Use this template button on the GitHub repository, or clone it directly:
Terminal
git clone https://github.com/gfazioli/next-app-fumadocs-template my-docs
cd my-docsInstall the dependencies
The project uses Yarn 4 (Berry). The postinstall script also
generates the .source folder used by Fumadocs:
Terminal
yarn installDo not use npm or pnpm: the repository ships a pinned Yarn release in .yarn/releases
and a yarn.lock lockfile.
Start the dev server
Terminal
yarn devOpen http://localhost:3000 — the landing page lives at / and
the documentation at /docs.
Write your first page
Every .mdx file inside content/docs becomes a page. The frontmatter title is
required, description is optional but recommended:
content/docs/hello.mdx
---
title: Hello World
description: My first page
---
Welcome to **my docs**!Then add the page to the sidebar order in content/docs/meta.json:
content/docs/meta.json
{
"pages": ["index", "hello"]
}Make it yours
Update the site configuration in config/index.ts (metadata, GitHub repository,
search language), the Mantine theme in theme.ts, and the landing page in
app/page.tsx.
Project anatomy
content/docs— your MDX content and themeta.jsonsidebar ordercomponents/mdx— the MDX component map: every HTML tag is rendered with Mantinecomponents/docs— the docs shell: sidebar, table of contents, search dialoglib/source.ts+source.config.ts— the Fumadocs content pipeline
Deploy
Two first-class options:
- Vercel — import the repository and deploy, no configuration needed. Dynamic search API, GitHub releases proxy, the works.
- GitHub Pages — fully static:
yarn build:staticproduces a static export (static Orama search index included), and the bundled workflow.github/workflows/deploy-pages.ymlpublishes it automatically on every push tomain. See the Search guide for details.