Rspress Tutorial
Welcome to the Rspress Tutorial! This comprehensive guide will take you from zero to hero, progressively teaching you Rspress, a modern static site generator built with Rust.
What is Rspress?
Rspress is a fast, flexible, and easy-to-use static site generator specifically designed for documentation websites. It combines Rust's high performance with modern frontend technologies, providing developers with an exceptional development experience.
Key Features
- ⚡ Blazing Fast - Built with Rust for ultra-fast build speeds
- 📝 MDX Support - Use React components in Markdown
- 🎨 Modern Theming - Beautiful themes out of the box
- 🔍 Full-text Search - Powerful built-in search functionality
- 🌍 Internationalization - Comprehensive multi-language support
- 📱 Responsive Design - Perfect adaptation for all devices
- 🔌 Plugin System - Flexible extensibility
Tutorial Contents
Basics
- Introduction - Understand Rspress core concepts and advantages
- Quick Start - Create your first Rspress project
- Conventional Routing - Understand Rspress routing mechanism
- Navigation & Sidebar - Configure website navigation structure
Intermediate
- Auto Navigation Generation - Automate navigation configuration
- MDX & React Components - Use interactive components in docs
- Static Assets - Manage images, styles, and other assets
- Static Site Generation (SSG/SSR) - Understand site generation mechanisms
- Internationalization (i18n) - Build multi-language documentation sites
- Deployment - Deploy your site to production
Advanced
- llms.txt - AI-optimized documentation indexing
- Code Blocks & Containers - Rich content presentation
- Custom Pages - Create special page layouts
- Custom Theme - Build unique visual styles
- Versioning - Manage multiple documentation versions
- Built-in Components - Use Rspress provided components
- Build Extensions - Extend functionality with plugins
- Custom Search - Customize search experience
Target Audience
- 🎓 Developers wanting to learn modern documentation tools
- 📚 Teams needing to build technical documentation
- 🚀 Projects pursuing ultimate performance
- 🌐 International projects requiring multi-language support
Learning Path
If you're a complete beginner, we recommend following this order:
- Start with Introduction to understand basic concepts
- Follow Quick Start to build your first project
- Learn basic configuration (routing, navigation, sidebar)
- Master content writing (MDX, code blocks, components)
- Dive into advanced features (theming, plugins, deployment)
Get Started
Ready to begin? Let's start with the Introduction and embark on this learning journey!
Resources
Note
This tutorial is continuously updated to stay in sync with the latest version of Rspress. Bookmark this page for future reference.