Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
Creating a new project is the first step toward building your documentation or application. The project creation tool automates the setup process, ensuring that your environment is correctly configured with the necessary dependencies and boilerplate code based on your chosen framework.
To create a new project, use the command line to run the setup tool. This tool will prompt you to select a template, which determines the framework and initial structure of your application.
Note
Ensure you have your preferred package manager (such as npm, pnpm, or yarn) installed before proceeding.
You can choose from several project templates. Each template is pre-configured with specific libraries:
| Standard documentation sites (Recommended) |
| Next.js Static: Fumadocs MDX | Sites requiring static hosting |
| Waku: Fumadocs MDX | Lightweight, modern React applications |
| React Router: Fumadocs MDX | Dynamic applications using React Router |
| React Router SPA | Static hosting with CDN compatibility |
| Tanstack Start: Fumadocs MDX | Advanced data-heavy React applications |
| Tanstack Start SPA | High-performance static web applications |
The setup process follows a streamlined flow to get you up and running:
Tip
If you plan to host your site on a Content Delivery Network (CDN), choose an SPA (Single Page Application) template. These are optimized for static hosting.
Tip
You can opt-in to have the tool automatically run dependency installation and initialize a Git repository for you, saving you from performing these steps manually.
Warning
While the tool handles dependency installation, verify your internet connection before starting, as the tool needs to reach registry services to download the necessary packages.
Once the process completes, the tool creates a folder containing your new project. Inside, you will find a generated configuration file and a standard documentation structure. The project is automatically named based on the output folder you specified during the setup, and all necessary internal links are pre-configured to ensure your documentation renders correctly.