# blade47/fumadocs > AI-generated documentation for github.com/blade47/fumadocs ## Technical docs: Orientation - [Overview](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/orientation/overview): Fumadocs is a modular documentation framework designed to bridge the gap between static content and dynamic, reactive documentation sites. At its core, the system solves the complexity of managing ... - [Quick Start](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/orientation/quick-start): The "Quick Start" subsystem facilitates the rapid scaffolding and initialization of Fumadocs-powered applications. Its primary goal is to abstract the complexity of configuring build tools, file-sy... - [Project Structure](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/orientation/project-structure): Fumadocs utilizes a monorepo architecture managed via pnpm workspaces, designed to decouple documentation core logic, UI implementations, and ecosystem integrations. This structure solves the compl... ## Technical docs: Content Processing - [MDX Bundling](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/mdx-bundling): MDX Bundling in Fumadocs is the bridge between static Markdown/MDX files and the framework-specific build pipelines (Vite, Next.js, Bun, Rolldown). It provides a unified system for transforming con... - [Page Trees](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/page-trees): Page Trees serve as the central hierarchical navigation model in Fumadocs, decoupling the physical organization of source files from the logical representation presented to end-users. They transfor... - [MDX Plugins](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/mdx-plugins): MDX Plugins act as the foundational processing layer within the Fumadocs documentation ecosystem, sitting directly atop the unified, remark, and rehype infrastructure. Their purpose is to augment s... - [Remote MDX](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/remote-mdx): Remote MDX is a specialized subsystem within the Fumadocs ecosystem that enables the dynamic compilation and execution of MDX content, typically outside of the primary build-time bundler context. B... - [Content Storage](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/content-storage): Content Storage provides the foundational abstraction layer that reconciles heterogeneous content sources—such as local Markdown/MDX files, Obsidian vaults, and OpenAPI or AsyncAPI specifications—i... - [Obsidian Vaults](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/obsidian-vaults): Obsidian Vaults in the context of Fumadocs serves as a bridging mechanism to transform standard, local Obsidian note repositories into structured, web-ready documentation content. It solves the com... - [I18n Routing](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/content-engine/i18n-routing): I18n Routing provides the infrastructure for multi-language support across the documentation system. It handles the critical tasks of detecting user locale, managing URL prefixes, and ensuring that... ## Technical docs: Search Infrastructure - [Search Indexing](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/search-subsystem/search-indexing): Search Indexing is the engine that enables performant full-text search within documentation sites. By transforming raw content—typically Markdown or MDX—into a structured, searchable format, the in... - [Orama Integration](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/search-subsystem/orama-integration): Orama Integration within the Fumadocs ecosystem provides a sophisticated, type-safe approach to full-text search. By leveraging Orama's high-performance search engine (both via Orama Cloud or stati... - [Search Clients](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/search-subsystem/search-clients): Search Clients in the Fumadocs ecosystem provide a unified interface for document search across diverse backends. They bridge the gap between UI components and search indexes, ensuring that users e... - [Search Dialogs](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/search-subsystem/search-dialogs): Search Dialogs are a core feature of the UI subsystem, providing a centralized interface for users to discover content across documentation sets. By offering a standardized way to invoke and naviga... ## Technical docs: API Generation - [OpenAPI Generation](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/api-documentation/openapi-generation): OpenAPI Generation provides a sophisticated pipeline to transform OpenAPI specification documents into interactive, structured documentation pages. At its core, the system acts as a specialized bui... - [AsyncAPI Generation](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/api-documentation/asyncapi-generation): "AsyncAPI Generation" is a robust subsystem dedicated to transforming complex AsyncAPI specifications into structured, navigable documentation. By leveraging a modular architecture, it abstracts th... - [API Schema Processing](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/api-documentation/api-schema-processing): API Schema Processing is a robust subsystem responsible for transforming, dereferencing, and visualizing complex API definitions (OpenAPI and AsyncAPI) into user-friendly documentation. At its hear... - [Code Generation](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/api-documentation/code-generation): Code Generation in this architecture is a specialized subsystem designed to bridge the gap between static API documentation and actionable, implementation-ready code. Its primary purpose is to tran... - [API UI](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/api-documentation/api-ui): API UI serves as the rendering layer for API documentation, transforming machine-readable specifications (OpenAPI and AsyncAPI) into interactive, human-readable documentation. It acts as a bridge b... ## Technical docs: Rendering and UI - [Layout System](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/layout-system): The Layout System provides a standardized, compositional framework for structuring documentation sites. It addresses the common challenge of fragmented UI components by offering unified primitives ... - [Sidebar Navigation](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/sidebar-navigation): Sidebar navigation is a foundational subsystem that provides structural document hierarchy visualization and site navigation. It serves as the primary way for users to traverse complex documentatio... - [Table of Contents](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/table-of-contents): The Table of Contents (TOC) subsystem in Fumadocs is a highly reactive, scroll-aware navigation component designed to synchronize with the page's DOM state. It bridges the gap between static conten... - [Syntax Highlighting](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/syntax-highlighting): Syntax Highlighting in this system is powered by Shiki, leveraging its high-performance tokenization capabilities to provide semantic code highlighting within MDX and React components. The system i... - [Base Components](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/base-components): Base Components constitute the foundational UI building blocks in the Fumadocs architecture, designed to provide a consistent, reusable, and accessible interface for documentation sites. These comp... - [Twoslash Highlight](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/twoslash-highlight): Twoslash Highlight is a sophisticated documentation enrichment subsystem that bridges the gap between static code samples and interactive TypeScript analysis. By integrating the twoslash engine dir... - [TypeScript Tables](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/rendering-ui/typescript-tables): "TypeScript Tables" in Fumadocs serve as an automated documentation bridge between TypeScript source code and human-readable web documentation. By utilizing static analysis of source files, the sys... ## Technical docs: Developer Tooling - [Command Line Interface](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/command-line-interface): The Fumadocs Command Line Interface (CLI) serves as the primary orchestration layer for initializing, configuring, and extending documentation projects. It solves the fragmentation of project scaff... - [App Templates](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/app-templates): App Templates serve as the scaffolding engine for the Fumadocs ecosystem, enabling the rapid generation of consistent, production-ready documentation sites. By defining structured, framework-specif... - [EPUB Exporter](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/epub-exporter): The EPUB Exporter is a dedicated subsystem for converting Fumadocs documentation into the standard EPUB format. By transforming Markdown/MDX content into semantic HTML and packaging it according to... - [Local Markdown Dev](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/local-markdown-dev): "Local Markdown Dev" provides the infrastructure for Fumadocs to handle local Markdown and MDX content, including storage management, compilation pipelines, and a development-time hot-reloading mec... - [Preview Environment](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/preview-environment): The Preview Environment subsystem provides a robust, real-time development and documentation rendering experience. By integrating dynamic compilation, filesystem watching, and reactive UI component... - [Story Visualizer](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/story-visualizer): The Story Visualizer is a sophisticated documentation subsystem designed to bridge the gap between static component documentation and interactive development environments. Its primary purpose is to... - [Shadcn Integration](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/developer-tools/shadcn-integration): The Shadcn Integration component is a specialized subsystem designed to bridge the gap between structured component registries and documentation delivery. It enables developers to generate manual i... ## Technical docs: How It Works - [MDX Configuration Loading](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/how-it-works/mdx-configuration-loading): The createMDX process acts as the integration layer between Fumadocs and Next.js. At a high level, this flow initializes the MDX core, manages configuration loading, and prepares the necessary path... - [Field Key Serialization](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/technical/how-it-works/field-key-serialization): The FieldSet to stringifyFieldKey flow represents the core mechanism for identifying and reacting to UI form field updates within the fumadocs story system. This process translates logical data pat... ## User guide: Getting Started - [Quickstart Guide](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/quickstart-guide): Getting your documentation website up and running with Fumadocs is designed to be fast and intuitive. Fumadocs provides a modern, clean, and highly customizable framework that allows you to turn yo... - [Creating Projects](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/creating-projects): Creating a new project is the first step toward building your documentation or application. The project creation tool automates the setup process, ensuring that your environment is correctly config... ## User guide: Core Features - [Writing Content](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/core-features/writing-content): Writing content in the system allows you to manage both the body text of your documents and supplementary metadata using a standard format. By using a structured header at the top of your document,... - [Site Search](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/core-features/site-search): The Site Search feature allows users to quickly find relevant information across your documentation. It provides a responsive search interface that processes queries against your chosen search prov... - [Navigation Layouts](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/core-features/navigation-layouts): Navigation layouts allow you to organize and structure how users move through your documentation or application. By defining a clear hierarchy, you ensure that visitors can easily find the content ... ## User guide: How-To Guides - [Interactive MDX](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/how-to-guides/interactive-mdx): Interactive MDX brings dynamic elements to your documentation, allowing you to organize information into engaging, user-friendly formats. Instead of static blocks of text, you can use these tools t... - [Multi-Language Sites](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/how-to-guides/multi-language-sites): Multi-language support allows you to reach a global audience by providing your documentation or site content in multiple languages. You can define which languages are supported, set a default, and ... - [Styling Themes](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/how-to-guides/styling-themes): Styling themes allow you to change the visual appearance of your interface, including background colors, text colors, and borders. By using predefined color schemes, you can ensure your application... ## User guide: Integrations - [API References](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/integrations/api-references): API References provide a structured, human-readable way to display technical documentation for your software's interfaces. By converting complex schemas into clear, interactive documentation, this ... - [AI Optimization](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/integrations/ai-optimization): AI Optimization allows you to generate a structured, text-based overview of your documentation that is specifically formatted for AI assistants. By creating an llms.txt file, you provide AI tools w... ## User guide: Troubleshooting - [Common Issues](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/troubleshooting/common-issues): This page covers common issues and questions you may encounter while using the Fumadocs CLI. Whether you are setting up your project, adding components, or exporting files, use this guide to troubl... ## Optional - [Full Documentation](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/llms-full.txt): Complete documentation content in a single file