Rspress

Rspress

rspress.dev

1

About this website

Rspress is a fast static site generator designed for building documentation websites, developed by the Web Infra team at ByteDance as part of the Rstack tooling ecosystem. The core compilation engine is built on the Rust-based Rspack bundler and Rsbuild build tool, delivering extreme compilation performance with near-instant cold starts and sub-second incremental rebuilds for large documentation projects with hundreds of pages. Content is authored in MDX, a format that combines Markdown syntax with embedded React components, enabling interactive documentation elements such as live code playgrounds, tabbed content, API reference tables, and custom visualizations within standard Markdown files. The framework generates a full-text search index at build time using a lightweight client-side engine, providing instant search across all documentation pages without requiring external services like Algolia. Production builds output static HTML files that can be deployed to any static hosting platform including Vercel, Netlify, GitHub Pages, or any CDN. The plugin system allows extending build behavior and theme UI through a typed API, with community plugins for redirect handling, last-updated timestamps, medium-style zoom, and code block title bars. The custom theme mechanism enables deep modification of the React component tree for branded documentation sites. AI integration is built in through SSG-MD, which generates llms.txt-compliant index files and Markdown exports during the static build, making documentation content accessible to large language models and AI coding tools. Agent Skills packages provide specialized capabilities for AI assistants. The broader Rstack ecosystem includes Rspack, Rsbuild, Rslib, Rsdoctor, Rstest, and Rslint. The project is open source under the MIT license.

Statistics

1
Views
0
Clicks
0
Like
0
Dislike

Comments

Log In to post a comment

No comments yet. Be the first!