Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
Getting your documentation website up and running with Fumadocs is designed to be fast and intuitive. Fumadocs provides a modern, clean, and highly customizable framework that allows you to turn your ideas into a professional documentation site with minimal effort.
This guide walks you through the essential steps to initialize your project, add your first piece of content, and preview your site locally.
The quickest way to get started is by using the automated installation command. Open your terminal or command prompt and run the following:
npx fumadocs-cli@latest initThis command will prompt you to choose your preferred package manager and project structure. Follow the on-screen instructions to set up the necessary foundation for your documentation.
Once the project is initialized, you can begin writing content. Fumadocs uses Markdown and MDX to render your pages. Create new pages by adding files to the designated content folder.
Tip
Use standard Markdown syntax (like headers, lists, and bold text) to keep your writing consistent and easy for the system to process.
To see your documentation in real-time as you write, start your local development server. Depending on the setup you chose during initialization, you will typically run:
npm run devOnce the server is running, open your web browser and navigate to the address shown in your terminal (usually http://localhost:3000). You can now see your site, update your files, and watch your changes appear instantly.
Understanding these terms will help you navigate your project more effectively.
The following diagram outlines the typical journey from initializing your environment to viewing your live site.
Note
Fumadocs automatically handles navigation and table of contents generation based on your file structure, so you don't need to manually link every page.
Warning
Ensure your folder naming conventions remain consistent, as these names often become the web addresses (URLs) for your documentation pages.
Important
If you encounter issues while running the installation command, verify that your environment has the latest version of your chosen package manager (such as npm, pnpm, or yarn) installed.