---
title: "Quickstart Guide"
description: "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 yo..."
last_updated: "2026-07-02T09:48:33.635757+00:00"
canonical_url: "https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/quickstart-guide"
---

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.

## 1. Initialize your project
The quickest way to get started is by using the automated installation command. Open your terminal or command prompt and run the following:

```bash
npx fumadocs-cli@latest init
```

This 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.

## 2. Create your documentation content
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.

*   **Markdown:** Best for simple text-based pages and articles.
*   **MDX:** Allows you to embed interactive components directly into your documentation, such as buttons, alerts, or custom visual aids.

> [!TIP]
> Use standard Markdown syntax (like headers, lists, and bold text) to keep your writing consistent and easy for the system to process.

## 3. Launch your local preview
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:

```bash
npm run dev
```

Once 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.

## Key Concepts
Understanding these terms will help you navigate your project more effectively.

| Term | Definition |
| :--- | :--- |
| **MDX** | Markdown with extra features, allowing you to use code components in your text. |
| **Local Preview** | A private version of your site running on your computer for testing before publishing. |
| **Project Setup** | The initial configuration process that installs the theme and layout tools. |

## Workflow Overview
The following diagram outlines the typical journey from initializing your environment to viewing your live site.

```mermaid
graph LR
    A[Run Init Command] --> B[Write Markdown/MDX Files]
    B --> C[Start Local Server]
    C --> D[View Site in Browser]
```

> [!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.

## Related

- [Creating Projects](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/creating-projects)


## Sitemap

See the full [sitemap](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/llms.txt) for all pages in this wiki.