https://github.com/web-infra-dev/rspress

🦀💨 A fast Rspack-based static site generator.
https://github.com/web-infra-dev/rspress

docs-generator hacktoberfest markdown mdx rspack ssg static-site-generator

Last synced: 3 days ago
JSON representation

🦀💨 A fast Rspack-based static site generator.

• Host: GitHub
• URL: https://github.com/web-infra-dev/rspress
• Owner: web-infra-dev
• License: mit
• Created: 2023-06-27T06:37:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-06T15:07:39.000Z (7 days ago)
• Last Synced: 2024-12-07T23:05:31.758Z (5 days ago)
• Topics: docs-generator, hacktoberfest, markdown, mdx, rspack, ssg, static-site-generator
• Language: TypeScript
• Homepage: https://rspress.dev
• Size: 9.33 MB
• Stars: 1,489
• Watchers: 17
• Forks: 140
• Open Issues: 112
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome - web-infra-dev/rspress - 🦀💨 A fast Rspack-based static site generator. (TypeScript)

README

        

  

# Rspress

A fast Rspack-based static site generator.



  

  

  

  



## 🔥 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](https://rspress.dev/guide/start/getting-started.html) to get started.

## 🤝 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.

## 🦀 Links

| Name                                                       | Description                                       |

| ---------------------------------------------------------- | ------------------------------------------------- |

| [@rspress/mdx-rs](https://github.com/web-infra-dev/mdx-rs) | Rust MDX compiler for Rspress.                    |

| [Rspack](https://github.com/web-infra-dev/rspack)          | A fast Rust-based web bundler.                    |

| [Rsbuild](https://github.com/web-infra-dev/rsbuild)        | An Rspack-based build tool for the web.           |

| [Rslib](https://github.com/web-infra-dev/rslib)            | A library build tool powered by Rsbuild.          |

| [Rsdoctor](https://github.com/web-infra-dev/rsdoctor)      | A one-stop build analyzer for Rspack and Webpack. |

## 🌟 Quality

Rspress uses [Web Infra QoS](https://web-infra-qos.netlify.app?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).