Rspress Best Practices

Apply these rules when writing or reviewing Rspress (v2) sites.

Configuration

• Use rspress.config.ts and defineConfig from @rspress/core
• Set root explicitly when docs are not under the default docs/ directory
• Keep site-wide settings such as title, description, icon, logo, base, and lang in config instead of repeating them in page files
• Prefer first-class Rspress options before custom theme code or low-level bundler overrides
• Keep custom theme code in a top-level theme/ directory and import original theme pieces from @rspress/core/theme-original

CLI

• Use rspress dev for local development
• Use rspress build for production output
• Use rspress preview only for local preview of the built site
• Use rspress eject only when CSS variables, class overrides, or layout wrapping cannot solve the customization