Rspress

A fast Rsbuild-based static site generator.

🔥 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

Rspress is part of Rstack, the fast, unified JavaScript toolchain for developers and agents.

🤝 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

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.