Awesome
<picture> <img alt="Rspress Banner" src="https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a"> </picture>Rspress
A fast Rspack-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?activeTab=readme"><img src="https://img.shields.io/npm/v/rspress?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" /></a> <a href="https://npmcharts.com/compare/rspress?minimal=true"><img src="https://img.shields.io/npm/dm/rspress.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a> <a href="https://github.com/web-infra-dev/rsbuild/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/rspress?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a> </p>🔥 Features
- 🚀 Fast Startup: Based on Rust-based build tool and markdown/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.
🤝 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"> <table> <tr> <th colspan="2"> <br/> <img src="https://contrib.rocks/image?repo=web-infra-dev/rspress&columns=16&max=96"><br/><br/> </th> </tr> <tr> <td> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=2x3&color_scheme=dark" /> <img alt="Contributors of web-infra-dev/rspress" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=2x3&color_scheme=light" /> </picture> </td> <td rowspan="2"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=4x7&color_scheme=dark"> <img alt="New trends of web-infra-dev" src="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=4x7&color_scheme=light"> </picture> </td> </tr> <tr> <td> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=2x3&color_scheme=dark" /> <img alt="Contributors of web-infra-dev/rspress" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_90_days&owner_id=87694465&repo_ids=659104635&image_size=2x3&color_scheme=light" /> </picture> </td> </tr> </table> </a>Code of Conduct
This repo has adopted the ByteDance Open Source Code of Conduct. Please check Code of Conduct for more details.
🦀 Links
| Name | Description |
|---|---|
| @rspress/mdx-rs | Rust MDX compiler for Rspress. |
| Rspack | A fast Rust-based web bundler. |
| Rsbuild | An Rspack-based build tool for the web. |
| Rslib | A library build tool powered by Rsbuild. |
| Rsdoctor | A one-stop build analyzer for Rspack and Webpack. |
🌟 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.