Introduction

Overview

@fumadocs/astro brings Fumadocs to Astro. You write MDX files, the integration builds the docs site around them:

Docs pages, search, llms.txt and the 404 page are created for you, with no routes, layouts or providers in your app.
Fumadocs UI renders as React islands.
Features like OG images and OpenAPI pages are added with plugins.

Quick Start

Create a new app (requires Node.js 22.23.4 or later):

npx create-fumadocs-app@latest my-docs --template astro

Start the dev server, and open /docs:

npm run dev

To add Fumadocs to an existing Astro app, see Manual Installation.

Project Structure

index.mdx

meta.json

mdx.tsx

layout.shared.tsx

source.ts

index.astro

global.css

content.config.ts

fumadocs.config.ts

astro.config.mjs

The site is defined in src/fumadocs.config.ts, with your page source:

src/fumadocs.config.ts

import { defineConfig } from '@fumadocs/astro/config';
import { source } from './lib/source';

export default defineConfig({
  source,
  title: 'Fumadocs on Astro',
});