Overview
Introduction
Getting started with Fumadocs is simple using the interactive command-line application initialization tool. The generator guides you through setting up a brand-new documentation site from scratch, allowing you to choose your preferred framework, template, search solution, linter, and package manager.
Note
Make sure your environment has Node.js installed (version 18.17.0 or higher is required) before running the setup commands.
Generating a New Project
To create a new Fumadocs application from scratch, run the setup tool via your package manager without installing it permanently:
npx create-fumadocs-app@latestDuring the interactive setup process, you will be prompted to answer several configuration choices:
- Project name: Enter a name for your project directory (defaults to
my-app). - Template: Choose the base framework and structure for your documentation site.
src/directory: (Next.js templates only) Choose whether to place your application code inside asrc/directory.- Linter: Choose a linter or formatter tool to keep your codebase clean.
- Search solution: Select how users will search through your documentation content.
- Open Graph Image generation: Choose the tool used to automatically generate social share preview images.
- AI Chat: Choose whether to integrate an AI-powered assistant into your documentation pages.
- Package manager installation: Choose whether to automatically install dependencies using your detected package manager.
Available Configuration Options
CLI Flags and Supported Values
Templates
Supported templates: +next+fuma-docs-mdx, waku, react-router, react-router-spa, tanstack-start, tanstack-start-spa, +next+fuma-docs-mdx+static
Linters
Supported linters: eslint, oxlint, biome
Search Solutions
Supported search solutions: orama, orama-cloud
Open Graph Image Generators
Supported OG image options: next-og, takumi
AI Chat Providers
Supported AI chat providers: openrouter, llmgateway, inkeep
Package Managers
Supported package managers: npm, pnpm, yarn, bun
Workflow Overview
Setup Lifecycle
The setup process follows a straightforward interactive lifecycle:
Tip
If you prefer to bypass all interactive prompts entirely, you can supply arguments and options directly in your terminal, such as providing a project name as the first argument:
npx create-fumadocs-app@latest my-docs --template +next+fuma-docs-mdx --install --no-git