Découvrez Rspress : un générateur de sites propulsé par Rust
Si vous maintenez une bibliothèque de composants React ou un projet destiné aux développeurs, vous avez probablement été confronté au même compromis : des outils de documentation soit rapides mais limités, soit flexibles mais lents. Rspress est conçu pour combler cet écart.
Points clés à retenir
- Rspress est un générateur de sites statiques basé sur React, propulsé par la chaîne d’outils de build Rspack en Rust, offrant des builds rapides avec un support complet de MDX.
- La version 2.0 introduit un système de thèmes en couches, la coloration syntaxique au moment du build avec Shiki, la compilation lazy par défaut, et une sortie Markdown optimisée pour l’IA via SSG-MD.
- Tous les packages principaux sont consolidés dans
@rspress/core, nécessitant Node.js 20+ et React 18 ou 19. - Rspress est particulièrement adapté à la documentation React et aux sites de bibliothèques de composants ; les projets Vue ou Svelte seront mieux servis par VitePress ou Docusaurus.
Qu’est-ce que Rspress ?
Rspress est un générateur de documentation React et un générateur de sites statiques construit sur Rsbuild et propulsé par le bundler Rspack — un bundler compatible webpack, basé sur Rust. Pour être précis : Rspress lui-même est un framework React, pas une application Rust. Les gains de performance proviennent de la chaîne d’outils de build Rspack propulsée par Rust en arrière-plan, tandis que vous écrivez votre documentation et vos composants en React et MDX comme vous le feriez normalement.
Il fait partie du vaste écosystème Rstack — une chaîne d’outils JavaScript unifiée construite autour de Rspack — qui inclut également Rsbuild, Rslib, Rsdoctor et Rstest.
Rspress cible deux cas d’usage principaux : les sites de documentation pour développeurs et la documentation de bibliothèques de composants. Il prend en charge MDX nativement, ce qui signifie que vous pouvez intégrer des composants React interactifs directement dans vos pages Markdown — utile lorsque vous avez besoin d’exemples interactifs accompagnant des explications écrites.
Quoi de neuf dans Rspress 2.0
Rspress 2.0, publié début 2026, va au-delà de la simple performance de build. Voici ce qui a changé.
Un système de thèmes repensé
Le thème par défaut a bénéficié d’une refonte visuelle complète. Plus important encore, la version 2.0 introduit quatre niveaux de personnalisation :
- Variables CSS — ajustez les couleurs, les arrière-plans des blocs de code et les styles de mise en page
- Noms de classes BEM — surchargez les styles de composants sans conflits avec les frameworks CSS
- Surcharges par ré-export ESM — remplacez n’importe quel composant intégré via
theme/index.tsx - Éjection de composants — copiez le code source d’un composant dans votre projet avec
rspress eject [component]et modifiez-le directement
Cela remplace l’API de thème instable de la version 1.x et vous offre un chemin de personnalisation prévisible et structuré en couches.
Shiki pour la coloration syntaxique au moment du build
Rspress 2.0 remplace la coloration syntaxique à l’exécution par Shiki, qui s’exécute au moment de la compilation. Cela signifie zéro surcharge à l’exécution, une coloration précise de style VS Code via les grammaires TextMate, et un support des transformateurs comme @rspress/plugin-twoslash pour les indications de types TypeScript inline.
Discover how at OpenReplay.com.
Démarrages plus rapides avec la compilation lazy
lazyCompilation est désormais activé par défaut. Les pages ne sont compilées que lorsque vous les visitez pendant le développement, ce qui signifie que le démarrage est quasi instantané quelle que soit la taille de votre site de documentation. Une stratégie de préchargement des routes au survol des liens maintient une navigation fluide.
La mise en cache persistante est également activée par défaut, réduisant les temps de build à chaud de 30 à 60 %.
Documentation optimisée pour l’IA avec SSG-MD
Rspress 2.0 introduit SSG-MD (Static Site Generation to Markdown) — une fonctionnalité qui génère votre documentation sous forme de fichiers Markdown propres en parallèle de la sortie HTML standard, puis génère les fichiers llms.txt et llms-full.txt suivant la spécification llms.txt.
import { defineConfig } from '@rspress/core';
export default defineConfig({
llms: true,
});Contrairement à la conversion de HTML vers Markdown après coup, SSG-MD fonctionne à partir du DOM virtuel React pendant le rendu, produisant une sortie de meilleure qualité. Vous pouvez également contrôler ce qui est inclus par composant en utilisant import.meta.env.SSG_MD. Notez que cette fonctionnalité est encore en maturation, et l’équipe a signalé des améliorations supplémentaires dans la feuille de route.
Consolidation des packages
Dans la version 2.0, les anciens packages rspress, @rspress/runtime, @rspress/shared et @rspress/theme-default sont fusionnés en un seul package @rspress/core. Le framework nécessite désormais Node.js 20+ et React 18 ou 19.
Devriez-vous utiliser Rspress ?
Rspress est un excellent choix si vous créez de la documentation pour un projet React ou une bibliothèque de composants et que vous souhaitez des builds rapides, un support MDX et un thème que vous pouvez réellement personnaliser. Il s’intègre directement avec Rslib pour les workflows de bibliothèques de composants, et l’écosystème de plugins — incluant la recherche Algolia, la génération de sitemap et twoslash — couvre la plupart des besoins des sites de documentation.
Si votre projet utilise Vue ou Svelte, ou si vous avez besoin d’un écosystème plus établi, VitePress ou Docusaurus restent des alternatives solides. Mais pour de la documentation React-first, Rspress 2.0 mérite un examen attentif.
FAQ
Rspress offre des temps de build plus rapides grâce à son bundler Rspack propulsé par Rust et intègre des fonctionnalités comme la compilation lazy et la mise en cache persistante par défaut. Docusaurus dispose d'un écosystème de plugins plus large et d'une communauté plus étendue. Si la vitesse de build brute et l'intégration étroite avec Rstack sont prioritaires, Rspress est le meilleur choix. Pour un écosystème plus mature, Docusaurus reste fiable.
Oui, mais vous devrez mettre à jour vos imports puisque tous les packages principaux sont désormais consolidés sous @rspress/core. L'API de thème a également changé, donc toutes les surcharges de thème personnalisées construites avec l'API 1.x devront être refactorisées pour utiliser le nouveau système de personnalisation en couches. L'équipe Rspress fournit un guide de migration dans la documentation officielle.
Non. Rspress est conçu spécifiquement pour React et MDX. Si votre projet utilise Vue, VitePress est une alternative bien supportée. Pour Svelte ou d'autres frameworks, vous devrez vous tourner vers d'autres générateurs de sites statiques. Rspress se concentre sur l'excellence de la documentation React-first plutôt que d'essayer de supporter plusieurs frameworks.
SSG-MD génère des fichiers Markdown propres à partir de votre documentation en parallèle de la sortie HTML standard. Elle produit également des fichiers llms.txt qui suivent une spécification émergente pour rendre le contenu des sites accessible aux grands modèles de langage. C'est utile si vous souhaitez que les outils d'IA référencent précisément votre documentation. La fonctionnalité fonctionne à partir du DOM virtuel React pour une sortie de meilleure qualité.
Gain Debugging Superpowers
Unleash the power of session replay to reproduce bugs, track slowdowns and uncover frustrations in your app. Get complete visibility into your frontend with OpenReplay — the most advanced open-source session replay tool for developers. Check our GitHub repo and join the thousands of developers in our community.
