A favicon of Fumadocs

Fumadocs

A documentation framework for React frameworks and Astro that supplies content, navigation, search and API reference as composable pieces.

Open Source Alternative to:

Screenshot of Fumadocs websiteVisit Fumadocs

Fumadocs is a framework for building documentation websites in React.js frameworks and Astro. Every documentation site needs the same scaffolding, a content pipeline, navigation, search and a readable theme, and Fumadocs supplies those so a team stops rebuilding them for each new project.

The design is compositional rather than a single template. A headless core handles content and navigation, a UI package supplies the themed pieces, and an MDX integration handles the writing layer, so a site can take the full theme or drop to headless mode and build its own. Officially supported targets are Next.js, Astro with React, and Vite setups including Tanstack Start, Waku and React Router.

The packages split along clear lines.

  • fumadocs-core: a headless library for docs management, content handling and navigation.
  • fumadocs-ui: the themed components, customized through Tailwind CSS.
  • fumadocs-mdx: the Markdown and MDX layer, with Shiki highlighting, codeblock grouping and callouts.
  • fumadocs-openapi: renders OpenAPI documentation from a schema.
  • fumadocs-obsidian: reads Obsidian style Markdown syntax.

Content does not have to live in files. Fumadocs reads MDX, Content Collections and external content managers such as BaseHub, Sanity and Payload CMS, while search plugs into Orama or Algolia. Server Components, Twoslash TypeScript documentation and Storybook integration are supported. All packages are ESM only, a CLI scaffolds a project and customizes the theme interactively, and the project is community funded rather than backed by a company.

Share:
Details:
  • Stars


    13,082
  • Forks


    728
  • Last commit


    5 days ago
  • Repository age


    3 years
  • License


    MIT
  • Version


    fumadocs@16.15.7
  • Repository


    fuma-nama/fumadocs

Auto-fetched from GitHub .

Ad

 

 
 
 
 

Open source alternatives similar to Fumadocs:

 

 
 
  • Stars


  • Forks


  • Last commit


 

 
 
  • Stars


  • Forks


  • Last commit


 

 
 
  • Stars


  • Forks


  • Last commit