Skip to Content
Fumadocs

Getting Started

Introducing Fumadocs MDX, the official content source of Fumadocs.

Introduction

Fumadocs MDX is a tool to transform content into type-safe data, similar to Content Collections.

It is not a full CMS but rather a content processing layer for React frameworks, you can use it to handle blog posts and other contents.

What is a Collection?

Collection refers to a collection containing a certain type of files. You can define them with the Macro API in your app:

lib/source.ts
import { defineDocs } from 'fumadocs-mdx/macro';
import { loader } from 'fumadocs-core/source';

const docs = defineDocs({
  dir: 'content/docs',
});

export const source = loader({
  baseUrl: '/docs',
  source: docs.toFumadocsSource(),
});

Available collections:

Compile Markdown & MDX files into a React component, with useful properties like Table of Contents.

import { defineCollections } from 'fumadocs-mdx/macro';

export const test = defineCollections({
  type: 'doc',
  dir: 'content/docs',
});

For example, a doc collection will transform the .md and .mdx files:

ui.md
hello.md
index.mdx
meta.json

You can also define collections in source.config.ts with the Config API, which generates entry files under .source.

Installation

Configure Fumadocs MDX on:

FAQ

Built-in Properties

These properties are exported from MDX files by default.

PropertyDescription
frontmatterFrontmatter
tocTable of Contents
structuredDataStructured Data, useful for implementing search
extractedReferencesFor analyzing hrefs references

Customize Frontmatter

Use the schema option to pass a validation schema to validate frontmatter and define its output properties.

An MDX page can also export frontmatter in code. The export is merged over the YAML frontmatter, and the collection schema validates the result:

content/docs/index.mdx
---
title: Introduction
---

import { version } from '../../package.json';

export const frontmatter = {
  description: `The docs of v${version}.`,
};

The export runs at build time. It can use the page's imports and the exports written before it in the same block, but not the content or components of the page. staticParams stays in the YAML frontmatter, because the loader reads it before the export runs.

Customize Compiler

Fumadocs MDX compiles MDX files into JavaScript files with unified, through MDX Compiler.

A collection can compile with Sätteri instead. Both come with a default preset of plugins and configurations.

You can customize it on Global Config or Collection Config.

How is this guide?