fuma-nama/fumadocs

Features

• Documentation Frameworks - Provides a framework for building content-heavy documentation sites using MDX, featuring interactive components, automated navigation, and built-in search.
• Technical Documentation - Builds content-heavy websites from structured text files with built-in navigation, search, and layout tools for technical projects.
• Static Site Generators - Compiles structured text files and data into optimized HTML and assets for deployment on web servers.
• MDX Processors - Transforms MDX files into interactive web pages by embedding custom components directly within markdown content.
• Static Documentation Generation - Generates content-heavy documentation sites from structured text files while providing built-in search, navigation, and content organization tools.
• Static Site Generation - Compiles documentation into optimized static HTML and assets for deployment on web servers or edge platforms.
• API Documentation Generators - Generates interactive API documentation pages from schema files to display endpoint details and request parameters.
• API References - Creates interactive web pages that display endpoint details, request samples, and live testing interfaces for developer-facing interfaces.
• Documentation Search - Structures technical content for machine-readable indexing and embedding chat interfaces to help users find answers using language models.
• Versioned Documentation - Maintains distinct sets of documentation for different software releases to ensure users access information relevant to their specific version.
• Page Layout Templates - Offers pre-built structural templates for arranging content-heavy documentation pages to ensure visual consistency.
• File-System-Based Routers - Automatically generates site navigation and URL structures based on the physical directory hierarchy of source files.
• AI Chat Interfaces - Adds interactive chat components to documentation pages that allow users to query technical content using language models.
• Documentation Components - Provides a library of modular UI components specifically designed for building interactive documentation layouts.
• Search Integrations - Provides connectors and adapters to integrate external search engines for indexing and retrieving documentation content.
• Interactive Playgrounds - Embeds interactive API playgrounds directly into documentation pages for real-time endpoint testing.
• Embedded Interface Components - Adds specialized interface elements like tabs, accordions, or code blocks to pages to enhance readability and user engagement.
• AI Documentation Resources - Structures content into machine-readable formats that allow large language models to index, retrieve, and summarize technical information accurately.
• Documentation Metadata Configurations - Defines and validates page properties using structured frontmatter to allow for custom configuration and data consistency across documentation files.
• Internationalization Support - Configures multi-language routing and content delivery to serve documentation in different languages based on user preferences.
• Search-Index-Based Retrieval - Implements client-side search indexing for fast, offline-capable information retrieval within documentation.
• React Components - Provides a collection of pre-built, customizable UI elements designed to enhance documentation layouts with interactive features and navigation.
• Custom Navigation Items - Adds persistent links to layouts for quick access to external resources or frequently visited pages, including sidebar and breadcrumb customization.
• Table of Contents Components - Creates a navigation list within the page body to help users jump to specific sections of long documents.
• UI Components - Provides a library of reusable UI components that include interactive previews for visualizing property changes in real-time.
• Static Site Deployment Tools - Generates static site builds to host documentation on standard web servers, container environments, or edge-compatible serverless platforms.
• AsyncAPI Example Generation - Converts event-driven AsyncAPI schema files into interactive documentation pages.
• Heading Identifiers - Creates and sanitizes URL-friendly anchors for all document headings to enable direct linking to specific sections.
• Text-to-Diagram Generators - Renders diagrams and flowcharts directly from text-based definitions within documentation pages.
• UI Framework Components - Facilitates the installation of pre-built UI components to accelerate the creation of interactive documentation features.
• Server-Side Data Fetching - Leverages server-side components to fetch and display live data or integrate with external systems for real-time updates.
• Global State Providers - Wraps the application in a centralized provider to synchronize theme settings and navigation status across all pages.
• Text Styling - Provides utilities for adjusting font properties and spacing to maintain a clear visual hierarchy in documentation text.
• Syntax Highlighting - Applies automatic syntax highlighting to code blocks, supporting various languages and advanced features like type information.
• Multi-Language Content Delivery - Manages multi-language routing and localized navigation structures to serve documentation to a global audience in their preferred language.
• Sidebar Isolation - Restricts sidebar visibility to specific root folders to help users focus on distinct product areas or documentation sets.
• Typed Data Collections - Transforms structured text and data files into type-safe collections for use as reusable components.
• API Request Collections - Provides example API request snippets in multiple programming languages to assist with integration.
• Interactive Command Switchers - Converts simple installation commands into interactive interfaces that allow users to switch between different package managers.
• Type Definition Generators - Creates structured tables from code definitions to display properties, types, and descriptions for technical schemas.
• Equation Renderers - Parses and displays mathematical notation within documents to support technical and scientific content.
• Tab Access Restrictions - Hides specific documentation pages or sections based on user permissions to protect sensitive information.
• External Content Inclusions - Embeds content from separate text files or external management systems to promote content reuse and enable real-time updates.
• Compile-Time Metadata Inspection - Parses frontmatter and document structures at compile-time to generate navigation and search indexes.
• Callouts - Provides styled callout blocks for tips, warnings, and success messages to improve content readability.
• Framework Integrations - Connects documentation content to web frameworks by providing the necessary configuration and routing logic for rendering.
• Directional - Applies CSS properties to control text reading direction, supporting right-to-left layouts for internationalization.

Star history