Notion

Introduction

@fumadocs/notion turns a Notion database into a Fumadocs content source. It provides a dynamic content source that pulls pages over the official Notion API, and a server renderer that renders Notion blocks with Fumadocs UI.

It does not ship a client-side renderer or convert content to MDX, blocks are rendered on the server, so there is no bundler or type-gen step.

Setup

Install the integration and the official Notion client:

npm install @fumadocs/notion @notionhq/client

Import the renderer's Tailwind CSS source after the Fumadocs UI styles:

@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
@import '@fumadocs/notion/css/preset.css';

NOTION_TOKEN=ntn_...
NOTION_DATA_SOURCE_ID=...

import { Client } from '@notionhq/client';
import { createNotion } from '@fumadocs/notion';

export const notion = createNotion({
  client: new Client({ auth: process.env.NOTION_TOKEN }),
  dataSourceId: process.env.NOTION_DATA_SOURCE_ID!,
});

import { dynamicLoader } from 'fumadocs-core/source/dynamic';
import { notion } from '@/lib/notion';

const source = dynamicLoader(
  notion.dynamicSource({
    // map Notion properties to page fields
    properties: {
      title: 'Name',
      slug: 'Slug',
      description: 'Description',
    },
    // filter, sort, or otherwise customize the query
    query: {
      filter: {
        property: 'Published',
        checkbox: { equals: true },
      },
    },
  }),
  {
    baseUrl: '/docs',
  },
);

export async function getSource() {
  return source.get();
}

import { getSource } from '@/lib/source';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';

export default async function Layout({ children }: LayoutProps<'/docs'>) {
  const source = await getSource();

  return <DocsLayout tree={source.getPageTree()}>{children}</DocsLayout>;
}

import { notFound } from 'next/navigation';
import { getSource } from '@/lib/source';
import {
  NotionRenderer,
  blocksToTableOfContents,
  createNotionFileUrlResolver,
} from '@fumadocs/notion';
import { DocsPage, DocsBody, DocsDescription, DocsTitle } from 'fumadocs-ui/layouts/docs/page';

export default async function Page({ params }: PageProps<'/docs/[[...slug]]'>) {
  const { slug = [] } = await params;
  const source = await getSource();

  const page = source.getPage(slug);
  if (!page) notFound();

  // load the page body
  const { blocks } = await page.data.load();

  return (
    <DocsPage toc={blocksToTableOfContents(blocks)}>
      <DocsTitle>{page.data.title}</DocsTitle>
      <DocsDescription>{page.data.description}</DocsDescription>
      <DocsBody>
        <NotionRenderer
          blocks={blocks}
          getFileUrl={createNotionFileUrlResolver({ pageId: page.data.id })}
        />
      </DocsBody>
    </DocsPage>
  );
}

import { createNotionFileHandler } from '@fumadocs/notion';
import { notion } from '@/lib/notion';

export const GET = createNotionFileHandler(notion);

createNotionFileUrlResolver({ pageId: page.data.id, path: '/notion/file' });

Revalidation

The loader caches pages until you invalidate it. To reflect Notion edits, call revalidate() from a trusted webhook or revalidation route:

export function revalidateNotion() {
  return source.revalidate();
}

For a preview-style setup where every request reflects the latest content, invalidate before reading:

export async function getSource() {
  source.invalidate();
  return source.get();
}

Page Properties

properties maps Notion properties to page fields. When omitted, the source:

• uses the first Notion title property as the page title,
• uses a property named Slug for the URL, falling back to a slug generated from the title,
• uses a property named Description when present.

A slug can contain / to create nested routes. Duplicate or unsafe virtual paths fail with a descriptive error instead of silently replacing a page.

Query and Paths

Pass Notion filters and sorts through query. Use baseDir to place the virtual pages under a directory, or generatePath for full control over the virtual file path:

notion.dynamicSource({
  baseDir: 'docs',
  query: {
    sorts: [{ timestamp: 'last_edited_time', direction: 'descending' }],
  },
  generatePath(page, info) {
    return info.slugs.length > 0 ? `${info.slugs.join('/')}.mdx` : `${page.id}.mdx`;
  },
});

Customize Rendering

NotionRenderer ships renderers for common block types. Pass components to add or override them, each override is typed against its block:

import { NotionRenderer } from '@fumadocs/notion';

<NotionRenderer
  blocks={blocks}
  components={{
    callout({ block, children, renderRichText }) {
      return (
        <aside className="rounded-lg bg-fd-muted p-4">
          {renderRichText(block.callout.rich_text)}
          {children}
        </aside>
      );
    },
  }}
/>;

Code blocks are highlighted on the server with Shiki by default. Pass highlightCode={false} to render plain code, or a function to plug in your own highlighter.

Source-only Import

Code that only pulls Notion pages, such as a search indexer or llms.txt route, can import from @fumadocs/notion/source to skip the React renderer entry:

import { createNotion } from '@fumadocs/notion/source';

This entry keeps the Notion SDK external and contains no React imports. blocksToPlainText(), blocksToStructuredData(), and blocksToTableOfContents() are available here too.