<picture> <img alt="Rspress Banner" src="https://assets.rspack.rs/rspress/rspress-banner.png"> </picture>

Rspress

A fast Rsbuild-based static site generator.

<p> <a href="https://discord.gg/mkVw5zPAtf"><img src="https://img.shields.io/badge/chat-discord-blue?logo=discord&colorA=564341&colorB=EDED91" alt="discord channel" /></a> <a href="https://npmjs.com/package/@rspress/core?activeTab=readme"><img src="https://img.shields.io/npm/v/@rspress/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a> <a href="https://npmcharts.com/compare/@rspress/core?minimal=true"><img src="https://img.shields.io/npm/dm/@rspress/core.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a> <a href="https://github.com/web-infra-dev/rspress/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@rspress/core?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a> <a href="https://deepwiki.com/web-infra-dev/rspress"><img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki" /></a> </p>

🔥 Features

• 🚀 Fast Startup: Based on Rsbuild and MDX compiler, the build speed is extremely fast, bringing you the ultimate development experience.
• 📚 MDX Support: MDX is a powerful way to write content, allowing you to use React components in Markdown.
• 📦 Built-in Full Text Search: Automatically generates a full-text search index for you during building process, providing out-of-the-box full-text search capabilities.
• 🌈 Static Site Generation: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
• 🔌 Providing Plugin System: Providing a plugin system, you can customize the build process and theme according to your needs.
• 📝 Component Document: Support multi ways to preview your component demo.

📚 Getting started

Go to the Quick start to get started.

🦀 Rstack

Rstack is a unified JavaScript toolchain centered on Rspack, with high performance and consistent architecture.

Name	Description	Version
Rspack	Bundler	<a href="https://npmjs.com/package/@rspack/core"><img src="https://img.shields.io/npm/v/@rspack/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rsbuild	Build tool	<a href="https://npmjs.com/package/@rsbuild/core"><img src="https://img.shields.io/npm/v/@rsbuild/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rslib	Library development tool	<a href="https://npmjs.com/package/@rslib/core"><img src="https://img.shields.io/npm/v/@rslib/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rspress	Static site generator	<a href="https://npmjs.com/package/@rspress/core"><img src="https://img.shields.io/npm/v/@rspress/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rsdoctor	Build analyzer	<a href="https://npmjs.com/package/@rsdoctor/core"><img src="https://img.shields.io/npm/v/@rsdoctor/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rstest	Testing framework	<a href="https://npmjs.com/package/@rstest/core"><img src="https://img.shields.io/npm/v/@rstest/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>
Rslint	Linter	<a href="https://npmjs.com/package/@rslint/core"><img src="https://img.shields.io/npm/v/@rslint/core?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a>

🤝 Contribution

Please read the contributing guide and let's build Rspress together.

If you have any questions, you can open an issue or go to Discord to communicate with us.

Contributors

<a href="https://github.com/web-infra-dev/rspress/graphs/contributors" target="_blank"> <img src="https://contrib.rocks/image?repo=web-infra-dev/rspress&columns=24"> </a>

Code of conduct

This repo has adopted the ByteDance Open Source Code of Conduct. Please check Code of Conduct for more details.

🧑‍💻 Community

Come and chat with us on Discord! The Rstack team and users are active there, and we're always looking for contributions.

🌟 Quality

Rspress uses Web Infra QoS to observe the trend of key metrics, such as bundle size, compile speed and install size.

📖 License

Rspress is licensed under the MIT License.