Sample
Getting Started
Quick start guide to get up and running with your project
Getting Started
Welcome! This guide will help you get started quickly.
Prerequisites: Make sure you have Node.js 18+ and npm/pnpm installed on your system.
Installation
Install the package
First, install the required dependencies using your preferred package manager:
npm install fumadocs-ui fumadocs-corepnpm add fumadocs-ui fumadocs-coreyarn add fumadocs-ui fumadocs-coreCreate configuration file
Create a source.config.ts file in your project root:
import { defineConfig, defineDocs } from 'fumadocs-mdx/config';
export const docs = defineDocs({
dir: 'content/docs',
});
export default defineConfig();Start development server
Run the development server:
npm run devYour app should now be running at http://localhost:3000
Quick Setup
If you prefer a faster setup, you can use the CLI tool:
npx create-fumadocs-app@latestThis will guide you through the setup process interactively.
Success! You're all set up and ready to start building your documentation.
Next Steps
Need Help?
If you run into any issues, check out our Troubleshooting Guide.