技术文档

VitePress is a static site generator designed for building documentation-focused websites. It functions as a framework that transforms markdown source files into pre-rendered HTML, utilizing file-based routing to map document paths directly to site URLs. By leveraging the Vue ecosystem, it enables the creation of content-heavy sites that combine static delivery with dynamic interactivity. The framework distinguishes itself by allowing developers to embed interactive components directly into markdown files, which are then transpiled into executable code modules. It optimizes the user experienc

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

Starlight is a documentation framework built on Astro for generating fast, searchable static websites. It functions as a markdown documentation engine that converts markup files into accessible pages using a file-based routing system. The framework allows for the embedding of custom UI components from various frontend frameworks directly into documentation layouts. This enables the creation of interactive guides and specialized user experiences within a static site structure. The system includes integrated navigation and search engine optimization, as well as schema-based frontmatter validat

Docusaurus is a documentation framework and static site generator designed to transform markdown files and component templates into optimized web pages. It functions as a content management platform for technical knowledge bases, utilizing a build process that pre-renders content into static HTML and JavaScript bundles to ensure site performance and search visibility. The framework distinguishes itself through a component-driven architecture that allows developers to build unique page layouts and interactive elements using reusable code blocks. It employs file-system-based routing to map dire

MkDocs is a static site generator designed specifically for creating project documentation. It functions as a command-line utility that transforms structured Markdown files into professional, searchable websites. By utilizing a centralized configuration file, it manages site metadata, navigation hierarchies, and build settings to ensure consistent output across documentation projects. The platform distinguishes itself through a highly extensible architecture that separates content from presentation. Users can apply visual themes to control the site's appearance, while a plugin-based build sys

Hugo is a high-performance static site generator that transforms source content and templates into optimized web assets. Built with a focus on speed and scalability, it provides a comprehensive framework for managing large-scale documentation and editorial projects through structured content organization, taxonomies, and a flexible template-driven rendering engine. The project distinguishes itself through a sophisticated build system that utilizes incremental caching to minimize redundant processing during site updates. It supports complex content requirements by enabling multidimensional mod

Gatsby is a React static site generator and hybrid rendering framework used to build websites by pre-rendering components into static HTML files for delivery via content delivery networks. It functions as a hybrid rendering platform that supports a combination of static generation, server-side rendering, and deferred page loading. The framework operates as a GraphQL data aggregator, pulling content from various APIs, headless CMS integrations, and files into a single unified schema for frontend queries. It also serves as a frontend performance optimizer, automating code splitting, resource pr

Nextra is a documentation framework for Next.js that functions as an MDX static site generator. It enables the creation of structured technical documentation sites by transforming MDX files into themed static pages with built-in layout and navigation. It serves as a React-based documentation tool that allows the integration of custom React components directly into markdown content. The framework distinguishes itself through integrated full-text search and a localization system that manages multilingual content via language routing and translation selectors. It also includes an AI-powered chat

mdBook is a documentation build system and static site generator designed to compile collections of Markdown files into structured, navigable web-based books. It provides a comprehensive framework for managing technical documentation, featuring a hierarchical table of contents, integrated full-text search, and automated build processes that transform source content into ready-to-deploy HTML websites. The project distinguishes itself through a highly modular pipeline architecture that supports custom preprocessors and swappable rendering backends. This allows authors to intercept and modify co

Hexo is a command-line static site generator designed for content-driven blogging and website creation. It functions as a structured framework that transforms plain text files and markdown into production-ready static websites, utilizing a template-based rendering engine to separate site content from visual presentation. The project is distinguished by its event-driven build pipeline, which manages the entire site lifecycle through a series of hooks for file processing, asset generation, and deployment. Developers can extend the system’s core capabilities through a modular plugin architecture

VuePress is a Vue-powered static site generator and markdown-based documentation tool. It transforms markdown files into static HTML pages, serving as a modular website builder that leverages Vue components for rendering and theme injection. The project is distinguished by a plugin-based architecture that allows the build process and runtime to be extended. It features a specialized framework for transforming static content into Progressive Web Apps with service worker integration for offline support. The system covers a broad range of capabilities, including internationalization for multi-l

Jekyll is a static site generator that transforms plain text files and markup into complete, deployable websites. It functions as a content management engine and blog-aware publishing platform, orchestrating a multi-stage build process that organizes structured data and source files into a consistent site architecture. The platform distinguishes itself through a specialized processing pipeline that automatically generates chronological archives, category indexes, and RSS feeds from collections of dated text files. It utilizes a template engine to inject dynamic content into layouts and suppor

Docsify is a client-side documentation framework and no-build static site generator. It functions as a browser-based engine that converts Markdown files into HTML on the fly, allowing for the generation of documentation websites without a static build or compilation process. The system employs a plugin interface and lifecycle hooks to modify the rendering process and extend site capabilities. It supports dynamic theme injection and visual style customization through external CSS and layout configurations. The framework includes capabilities for multi-language content management, full-text se