# 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](https://rspress.rs/guide/start/getting-started.html) to get started.
## 🦀 Rstack
Rspress is part of Rstack, the fast, unified JavaScript toolchain for developers and agents.
| Name | Description | Version |
| ----------------------------------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Rspack](https://github.com/web-infra-dev/rspack) | Bundler | 
|
| [Rsbuild](https://github.com/web-infra-dev/rsbuild) | Build tool | 
|
| [Rslib](https://github.com/web-infra-dev/rslib) | Library development tool | 
|
| [Rspress](https://github.com/web-infra-dev/rspress) | Static site generator | |
| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor) | Build analyzer | 
|
| [Rstest](https://github.com/web-infra-dev/rstest) | Testing framework | 
|
| [Rslint](https://github.com/web-infra-dev/rslint) | Linter | 
|
## 🤝 Contribution
Please read the [contributing guide](./CONTRIBUTING.md) and let's build Rspress together.
If you have any questions, you can open an issue or go to [Discord](https://discord.com/invite/Cq6HweJM26) to communicate with us.
### Contributors
### Code of conduct
This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
## 🧑💻 Community
Come and chat with us on [Discord](https://discord.gg/XsaKEEk4mW)! The Rstack team and users are active there, and we're always looking for contributions.
## 🌟 Quality
Rspress uses [Web Infra QoS](https://web-infra-qos.pages.dev/?product=rspress) to observe the trend of key metrics, such as bundle size, compile speed and install size.
## 📖 License
Rspress is licensed under the [MIT License](./LICENSE).