# fuma-nama/fumadocs

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/fuma-nama-fumadocs).**

10,863 stars · 608 forks · TypeScript · mit

## Links

- GitHub: https://github.com/fuma-nama/fumadocs
- Homepage: https://fumadocs.dev
- awesome-repositories: https://awesome-repositories.com/repository/fuma-nama-fumadocs.md

## Topics

`app-router` `content-collections` `contentlayer` `docs` `fumadocs` `mdx` `next` `nextjs` `react-router` `tailwindcss` `tanstack-router` `typescript`

## Description

Fumadocs is a documentation framework designed for building content-heavy technical websites using MDX. It functions as a static site generator that transforms structured text files into optimized, interactive web pages, providing a comprehensive toolset for managing technical content, API references, and versioned guides.

The platform distinguishes itself through a deep integration of interactive components and AI-ready features. It includes a library of pre-built interface elements that allow developers to embed live API playgrounds, request snippets, and schema-based documentation directly into their pages. Furthermore, the framework structures content for machine-readable indexing, enabling AI-powered search and chat interfaces that allow users to query technical information using natural language.

Beyond its core rendering capabilities, the project provides extensive support for site management, including internationalization, multi-version documentation, and granular navigation control. It automates common documentation tasks such as file-system-based routing, search indexing, and metadata extraction, while offering flexible styling options for themes, typography, and layout dimensions.

The framework is designed for integration with modern web development workflows, offering command-line utilities for project scaffolding and component installation. It supports deployment across standard web servers and edge hosting platforms through framework-specific adapters and static build configurations.

## Tags

### Content Management & Publishing

- [Documentation Frameworks](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/documentation-frameworks.md) — Provides a framework for building content-heavy documentation sites using MDX, featuring interactive components, automated navigation, and built-in search.
- [Technical Documentation](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/technical-documentation.md) — Builds content-heavy websites from structured text files with built-in navigation, search, and layout tools for technical projects.
- [Static Site Generators](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators.md) — Compiles structured text files and data into optimized HTML and assets for deployment on web servers.
- [MDX Processors](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/mdx-processors.md) — Transforms MDX files into interactive web pages by embedding custom components directly within markdown content.
- [Static Documentation Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-documentation-generation.md) — Generates content-heavy documentation sites from structured text files while providing built-in search, navigation, and content organization tools. ([source](https://fumadocs.dev/docs/what-is-fumadocs))
- [Static Site Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-site-generation.md) — Compiles documentation into optimized static HTML and assets for deployment on web servers or edge platforms.
- [Documentation Components](https://awesome-repositories.com/f/content-management-publishing/documentation-knowledge-management/documentation-components.md) — Provides a library of modular UI components specifically designed for building interactive documentation layouts.
- [Documentation Metadata Configurations](https://awesome-repositories.com/f/content-management-publishing/documentation-metadata-configurations.md) — Defines and validates page properties using structured frontmatter to allow for custom configuration and data consistency across documentation files. ([source](https://fumadocs.dev/docs/mdx))
- [Static Site Deployment Tools](https://awesome-repositories.com/f/content-management-publishing/static-site-deployment-tools.md) — Generates static site builds to host documentation on standard web servers, container environments, or edge-compatible serverless platforms. ([source](https://fumadocs.dev/docs))
- [Sidebar Isolation](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/document-models/document-sectioning/sidebar-isolation.md) — Restricts sidebar visibility to specific root folders to help users focus on distinct product areas or documentation sets. ([source](https://fumadocs.dev/docs/page-conventions))

### Development Tools & Productivity

- [API Documentation Generators](https://awesome-repositories.com/f/development-tools-productivity/api-documentation-generators.md) — Generates interactive API documentation pages from schema files to display endpoint details and request parameters. ([source](https://fumadocs.dev/docs/integrations/openapi))
- [Interactive Playgrounds](https://awesome-repositories.com/f/development-tools-productivity/developer-utilities-libraries/workflow-productivity-enhancers/developer-productivity-utilities/developer-experience/interactive-debugging-testing/interactive-playgrounds.md) — Embeds interactive API playgrounds directly into documentation pages for real-time endpoint testing. ([source](https://fumadocs.dev/docs/integrations/openapi))
- [Internationalization Support](https://awesome-repositories.com/f/development-tools-productivity/internationalization-support.md) — Configures multi-language routing and content delivery to serve documentation in different languages based on user preferences. ([source](https://fumadocs.dev/docs/internationalization))
- [Search-Index-Based Retrieval](https://awesome-repositories.com/f/development-tools-productivity/search-indexing-tools/search-index-based-retrieval.md) — Implements client-side search indexing for fast, offline-capable information retrieval within documentation.
- [AsyncAPI Example Generation](https://awesome-repositories.com/f/development-tools-productivity/api-documentation-generators/asyncapi-example-generation.md) — Converts event-driven AsyncAPI schema files into interactive documentation pages. ([source](https://fumadocs.dev/docs/integrations/asyncapi))
- [API Request Collections](https://awesome-repositories.com/f/development-tools-productivity/api-development-tools/api-lifecycle-management/api-request-collections.md) — Provides example API request snippets in multiple programming languages to assist with integration. ([source](https://fumadocs.dev/docs/integrations/openapi))
- [Interactive Command Switchers](https://awesome-repositories.com/f/development-tools-productivity/package-installers/command-based-package-installation/interactive-command-switchers.md) — Converts simple installation commands into interactive interfaces that allow users to switch between different package managers. ([source](https://fumadocs.dev/docs/markdown))
- [Type Definition Generators](https://awesome-repositories.com/f/development-tools-productivity/type-definition-generators.md) — Creates structured tables from code definitions to display properties, types, and descriptions for technical schemas. ([source](https://fumadocs.dev/docs/ui/components))

### Education & Learning Resources

- [API References](https://awesome-repositories.com/f/education-learning-resources/developer-documentation-references/knowledge-bases/technical-references/api-references.md) — Creates interactive web pages that display endpoint details, request samples, and live testing interfaces for developer-facing interfaces.

### Artificial Intelligence & ML

- [Documentation Search](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-powered-search/documentation-search.md) — Structures technical content for machine-readable indexing and embedding chat interfaces to help users find answers using language models.
- [AI Chat Interfaces](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-chat-interfaces.md) — Adds interactive chat components to documentation pages that allow users to query technical content using language models. ([source](https://fumadocs.dev/docs/integrations/llms))
- [AI Documentation Resources](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-documentation-resources.md) — Structures content into machine-readable formats that allow large language models to index, retrieve, and summarize technical information accurately. ([source](https://fumadocs.dev/docs/integrations/llms))

### Software Engineering & Architecture

- [Versioned Documentation](https://awesome-repositories.com/f/software-engineering-architecture/versioned-documentation.md) — Maintains distinct sets of documentation for different software releases to ensure users access information relevant to their specific version. ([source](https://fumadocs.dev/docs/navigation))
- [Heading Identifiers](https://awesome-repositories.com/f/software-engineering-architecture/identifier-generators/heading-identifiers.md) — Creates and sanitizes URL-friendly anchors for all document headings to enable direct linking to specific sections. ([source](https://fumadocs.dev/docs/markdown))
- [Text-to-Diagram Generators](https://awesome-repositories.com/f/software-engineering-architecture/software-architecture/diagramming-standards/text-to-diagram-generators.md) — Renders diagrams and flowcharts directly from text-based definitions within documentation pages. ([source](https://fumadocs.dev/docs/markdown))
- [External Content Inclusions](https://awesome-repositories.com/f/software-engineering-architecture/external-content-handlers/external-content-inclusions.md) — Embeds content from separate text files or external management systems to promote content reuse and enable real-time updates. ([source](https://fumadocs.dev/docs/markdown))
- [Compile-Time Metadata Inspection](https://awesome-repositories.com/f/software-engineering-architecture/software-architecture/architectural-patterns/abstraction-domain-modeling/compile-time-architectural-patterns/compile-time-metaprogramming/compile-time-metadata-inspection.md) — Parses frontmatter and document structures at compile-time to generate navigation and search indexes.

### User Interface & Experience

- [Page Layout Templates](https://awesome-repositories.com/f/user-interface-experience/page-layout-templates.md) — Offers pre-built structural templates for arranging content-heavy documentation pages to ensure visual consistency. ([source](https://fumadocs.dev/docs/ui/layouts))
- [Embedded Interface Components](https://awesome-repositories.com/f/user-interface-experience/embedded-interface-components.md) — Adds specialized interface elements like tabs, accordions, or code blocks to pages to enhance readability and user engagement. ([source](https://fumadocs.dev/docs/ui))
- [React Components](https://awesome-repositories.com/f/user-interface-experience/component-utilities/ui-frameworks/component-libraries/react-components.md) — Provides a collection of pre-built, customizable UI elements designed to enhance documentation layouts with interactive features and navigation.
- [Custom Navigation Items](https://awesome-repositories.com/f/user-interface-experience/navigation-links/custom-navigation-items.md) — Adds persistent links to layouts for quick access to external resources or frequently visited pages, including sidebar and breadcrumb customization. ([source](https://fumadocs.dev/docs/navigation))
- [Table of Contents Components](https://awesome-repositories.com/f/user-interface-experience/table-of-contents-components.md) — Creates a navigation list within the page body to help users jump to specific sections of long documents. ([source](https://fumadocs.dev/docs/ui/components))
- [UI Components](https://awesome-repositories.com/f/user-interface-experience/ui-components.md) — Provides a library of reusable UI components that include interactive previews for visualizing property changes in real-time. ([source](https://fumadocs.dev/docs/integrations/story))
- [UI Framework Components](https://awesome-repositories.com/f/user-interface-experience/component-utilities/ui-frameworks/component-libraries/ui-framework-components.md) — Facilitates the installation of pre-built UI components to accelerate the creation of interactive documentation features. ([source](https://fumadocs.dev/docs/cli))
- [Server-Side Data Fetching](https://awesome-repositories.com/f/user-interface-experience/content-rendering-components/server-side-data-fetching.md) — Leverages server-side components to fetch and display live data or integrate with external systems for real-time updates. ([source](https://fumadocs.dev/docs/what-is-fumadocs))
- [Global State Providers](https://awesome-repositories.com/f/user-interface-experience/global-state-providers.md) — Wraps the application in a centralized provider to synchronize theme settings and navigation status across all pages. ([source](https://fumadocs.dev/docs/ui/layouts))
- [Text Styling](https://awesome-repositories.com/f/user-interface-experience/styling-theming-systems/typography-and-iconography/text-styling.md) — Provides utilities for adjusting font properties and spacing to maintain a clear visual hierarchy in documentation text. ([source](https://fumadocs.dev/docs/ui/theme))
- [Syntax Highlighting](https://awesome-repositories.com/f/user-interface-experience/syntax-highlighting.md) — Applies automatic syntax highlighting to code blocks, supporting various languages and advanced features like type information. ([source](https://fumadocs.dev/docs/markdown))
- [Callouts](https://awesome-repositories.com/f/user-interface-experience/callouts.md) — Provides styled callout blocks for tips, warnings, and success messages to improve content readability. ([source](https://fumadocs.dev/docs/markdown))

### Web Development

- [File-System-Based Routers](https://awesome-repositories.com/f/web-development/routing-systems/routing/route-definition-strategies/file-system-based-routers.md) — Automatically generates site navigation and URL structures based on the physical directory hierarchy of source files.
- [Multi-Language Content Delivery](https://awesome-repositories.com/f/web-development/internationalization-localization/translation-management-platforms/site-localization/multi-language-content-delivery.md) — Manages multi-language routing and localized navigation structures to serve documentation to a global audience in their preferred language.
- [Framework Integrations](https://awesome-repositories.com/f/web-development/framework-integrations.md) — Connects documentation content to web frameworks by providing the necessary configuration and routing logic for rendering. ([source](https://fumadocs.dev/docs/manual-installation))
- [Directional](https://awesome-repositories.com/f/web-development/frontend-development-tools/frontend-frameworks/directives/directional.md) — Applies CSS properties to control text reading direction, supporting right-to-left layouts for internationalization. ([source](https://fumadocs.dev/docs/ui/theme))

### Data & Databases

- [Search Integrations](https://awesome-repositories.com/f/data-databases/search-integrations.md) — Provides connectors and adapters to integrate external search engines for indexing and retrieving documentation content. ([source](https://fumadocs.dev/docs/deploying/static))
- [Typed Data Collections](https://awesome-repositories.com/f/data-databases/typed-data-collections.md) — Transforms structured text and data files into type-safe collections for use as reusable components. ([source](https://fumadocs.dev/docs/mdx))

### Scientific & Mathematical Computing

- [Equation Renderers](https://awesome-repositories.com/f/scientific-mathematical-computing/numerical-mathematical-foundations/mathematical-typesetting-engines/mathematical-typesetting/equation-renderers.md) — Parses and displays mathematical notation within documents to support technical and scientific content. ([source](https://fumadocs.dev/docs/markdown))

### Security & Cryptography

- [Tab Access Restrictions](https://awesome-repositories.com/f/security-cryptography/role-based-access-control/tab-access-restrictions.md) — Hides specific documentation pages or sections based on user permissions to protect sensitive information. ([source](https://fumadocs.dev/docs/guides))