Back

Rspress: Ein Rust-basierter Site-Generator

Rspress: Ein Rust-basierter Site-Generator

Wenn Sie eine React-Komponentenbibliothek oder ein entwicklerorientiertes Projekt pflegen, haben Sie wahrscheinlich schon mit demselben Kompromiss gerungen: Dokumentationstools, die entweder schnell, aber eingeschränkt sind, oder flexibel, aber langsam. Rspress wurde entwickelt, um diese Lücke zu schließen.

Wichtigste Erkenntnisse

  • Rspress ist ein React-basierter Static-Site-Generator, der von Rspacks Rust-Build-Toolchain angetrieben wird und schnelle Builds mit vollständiger MDX-Unterstützung bietet.
  • Version 2.0 führt ein mehrschichtiges Theme-System, Build-Time-Syntaxhervorhebung mit Shiki, Lazy Compilation als Standard und KI-freundliche Markdown-Ausgabe über SSG-MD ein.
  • Alle Kernpakete sind in @rspress/core konsolidiert und erfordern Node.js 20+ sowie React 18 oder 19.
  • Rspress eignet sich am besten für React-orientierte Dokumentation und Komponentenbibliotheks-Websites; Vue- oder Svelte-Projekte sind möglicherweise mit VitePress oder Docusaurus besser bedient.

Was ist Rspress?

Rspress ist ein React-Dokumentationsgenerator und Static-Site-Generator, der auf Rsbuild aufbaut und vom Rspack-Bundler angetrieben wird – einem Rust-basierten, webpack-kompatiblen Bundler. Um präzise zu sein: Rspress selbst ist ein React-Framework, keine Rust-Anwendung. Die Performance-Gewinne stammen von Rspacks Rust-basierter Build-Toolchain im Hintergrund, während Sie Ihre Dokumentation und Komponenten wie gewohnt in React und MDX schreiben.

Es ist Teil des umfassenderen Rstack-Ökosystems – einer einheitlichen JavaScript-Toolchain, die auf Rspack aufbaut – zu dem auch Rsbuild, Rslib, Rsdoctor und Rstest gehören.

Rspress zielt auf zwei primäre Anwendungsfälle ab: Entwicklerdokumentations-Websites und Komponentenbibliotheks-Dokumentation. Es unterstützt MDX standardmäßig, was bedeutet, dass Sie Live-React-Komponenten direkt in Ihre Markdown-Seiten einbetten können – nützlich, wenn Sie interaktive Beispiele neben schriftlichen Erklärungen benötigen.

Was ist neu in Rspress 2.0

Rspress 2.0, Anfang 2026 veröffentlicht, geht über reine Build-Performance hinaus. Hier ist, was sich geändert hat.

Ein neu gestaltetes Theme-System

Das Standard-Theme erhielt eine vollständige visuelle Überarbeitung. Noch wichtiger ist, dass 2.0 vier Anpassungsebenen einführt:

  • CSS-Variablen – passen Sie Farben, Code-Block-Hintergründe und Layout-Stile an
  • BEM-Klassennamen – überschreiben Sie Komponentenstile ohne CSS-Framework-Konflikte
  • ESM-Re-Export-Overrides – ersetzen Sie jede eingebaute Komponente über theme/index.tsx
  • Component Eject – kopieren Sie den Quellcode einer Komponente mit rspress eject [component] in Ihr Projekt und modifizieren Sie ihn direkt

Dies ersetzt die instabile Theme-API aus 1.x und gibt Ihnen einen vorhersehbaren, mehrschichtigen Anpassungspfad.

Shiki für Build-Time-Syntaxhervorhebung

Rspress 2.0 ersetzt die Laufzeit-Hervorhebung durch Shiki, das zur Kompilierzeit läuft. Das bedeutet null Laufzeit-Overhead, präzise VS-Code-ähnliche Hervorhebung über TextMate-Grammatiken und Unterstützung für Transformatoren wie @rspress/plugin-twoslash für Inline-TypeScript-Typhinweise.

Schnellere Dev-Starts mit Lazy Compilation

lazyCompilation ist jetzt standardmäßig aktiviert. Seiten werden nur kompiliert, wenn Sie sie während der Entwicklung besuchen, was bedeutet, dass der Start nahezu sofort erfolgt, unabhängig davon, wie groß Ihre Dokumentations-Website ist. Eine Route-Preload-Strategie beim Link-Hover sorgt dafür, dass die Navigation nahtlos wirkt.

Persistentes Caching ist ebenfalls standardmäßig aktiviert und reduziert Warm-Start-Build-Zeiten um 30–60 %.

KI-freundliche Dokumentation mit SSG-MD

Rspress 2.0 führt SSG-MD (Static Site Generation to Markdown) ein – ein Feature, das Ihre Dokumentation als saubere Markdown-Dateien neben der Standard-HTML-Ausgabe rendert und dann llms.txt- und llms-full.txt-Dateien gemäß der llms.txt-Spezifikation generiert.

import { defineConfig } from '@rspress/core';

export default defineConfig({
  llms: true,
});

Im Gegensatz zur nachträglichen Konvertierung von HTML zu Markdown arbeitet SSG-MD während des Renderings vom React Virtual DOM aus und produziert qualitativ hochwertigere Ausgaben. Sie können auch steuern, was pro Komponente mit import.meta.env.SSG_MD einbezogen wird. Beachten Sie, dass dieses Feature noch in der Entwicklung ist und das Team weitere Verfeinerungen als Teil der Roadmap angekündigt hat.

Paketkonsolidierung

In 2.0 werden die alten Pakete rspress, @rspress/runtime, @rspress/shared und @rspress/theme-default in ein einziges @rspress/core-Paket zusammengeführt. Das Framework erfordert jetzt Node.js 20+ und React 18 oder 19.

Sollten Sie Rspress verwenden?

Rspress ist eine gute Wahl, wenn Sie Dokumentation für ein React-Projekt oder eine Komponentenbibliothek erstellen und schnelle Builds, MDX-Unterstützung und ein Theme wünschen, das Sie tatsächlich anpassen können. Es integriert sich direkt mit Rslib für Komponentenbibliotheks-Workflows, und das Plugin-Ökosystem – einschließlich Algolia-Suche, Sitemap-Generierung und Twoslash – deckt die meisten Anforderungen von Dokumentations-Websites ab.

Wenn Ihr Projekt Vue oder Svelte verwendet oder Sie ein etablierteres Ökosystem benötigen, bleiben VitePress oder Docusaurus solide Alternativen. Aber für React-orientierte Dokumentation ist Rspress 2.0 einen genauen Blick wert.

Häufig gestellte Fragen

Rspress bietet dank seines Rust-basierten Rspack-Bundlers schnellere Build-Zeiten und liefert Features wie Lazy Compilation und persistentes Caching standardmäßig mit. Docusaurus hat ein größeres Plugin-Ökosystem und eine breitere Community. Wenn reine Build-Geschwindigkeit und enge Rstack-Integration am wichtigsten sind, ist Rspress die stärkere Wahl. Für ein ausgereifteres Ökosystem bleibt Docusaurus zuverlässig.

Ja, aber Sie müssen Ihre Imports aktualisieren, da alle Kernpakete jetzt unter @rspress/core konsolidiert sind. Die Theme-API hat sich ebenfalls geändert, sodass alle benutzerdefinierten Theme-Overrides, die gegen die 1.x-API erstellt wurden, refaktoriert werden müssen, um das neue mehrschichtige Anpassungssystem zu verwenden. Das Rspress-Team stellt einen Migrationsleitfaden in der offiziellen Dokumentation bereit.

Nein. Rspress ist speziell für React und MDX konzipiert. Wenn Ihr Projekt Vue verwendet, ist VitePress eine gut unterstützte Alternative. Für Svelte oder andere Frameworks müssten Sie sich nach anderen Static-Site-Generatoren umsehen. Rspress konzentriert sich darauf, React-orientierte Dokumentation gut zu machen, anstatt zu versuchen, mehrere Frameworks zu unterstützen.

SSG-MD generiert saubere Markdown-Dateien aus Ihrer Dokumentation neben der Standard-HTML-Ausgabe. Es erstellt auch llms.txt-Dateien, die einer aufkommenden Spezifikation folgen, um Website-Inhalte für große Sprachmodelle zugänglich zu machen. Dies ist nützlich, wenn Sie möchten, dass KI-Tools Ihre Dokumentation präzise referenzieren. Das Feature arbeitet vom React Virtual DOM aus für qualitativ hochwertigere Ausgaben.

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.

OpenReplay