React-Dokumentation. Frisch gebacken als HTML.
Ardo ist ein statischer Seitengenerator für React-Projekte. Anleitungen in Markdown und MDX, eine API-Referenz aus deinem TypeScript und eine Suche – alles beim Build mit Rust vorgerendert.
← bei jedem Build frisch von npm
deine Ordner werden zu dieser Leiste
beim Build hervorgehoben
so funktioniert’s
Vom Repository zur Website, ohne Serverpflege.
Schreiben
- Anleitungen in Markdown und MDX
- Deine eigenen Komponenten und Layouts
- API-Referenz aus TypeScript
- Typisierte Inhaltssammlungen
Bauen
Rust-Werkzeuge kompilieren dein Markdown und färben jeden Codeblock ein, TypeScript 7 liest deine Typen und Vite bündelt den Rest. Suchindex, Sitemap und llms.txt kommen aus demselben Ofen.
Ausliefern
Jede Seite ist vollständiges HTML. Suchmaschinen sehen alles, Leser bekommen den Inhalt mit der ersten Anfrage und jeder statische Hoster reicht aus.
der einfache Einstieg
Lass deinen Agenten das Setup übernehmen.
Kein Starter-Template, kein Kopiermarathon. Gib diesen Satz deinem Coding-Agenten, in einem neuen oder bestehenden Repository. Der Link führt ihn zu Ardos offizieller Anleitung. Er passt das getestete Beispiel an und berichtet über Typprüfung, Tests und Build. Du prüfst das Ergebnis wie jeden anderen Pull Request.
Richte Ardo in diesem Repository nach https://
ja, das ist der ganze Prompt. Zeit für einen Kaffee.
unter der Haube
Schnell bis ins Fundament.
Ardo baut auf starken Werkzeugen auf. Zwei davon stammen direkt aus unserer eigenen Werkstatt, geschrieben in Rust.
Ferromark
Unser Markdown- und MDX-Compiler. Aus Seiten werden React-Komponenten; Überschriften, Inhaltsverzeichnis und Suchdaten entstehen dabei gleich mit.
2,6× schneller als pulldown-cmark auf 50 echten Dokumenten.
Ferriki
Unser Syntax-Highlighter. Jeder Codeblock bekommt seine Farben beim Build, hell und dunkel. Im Browser bleibt nichts mehr zu tun.
4,7× schneller als Shiki auf WebAssembly, identisches HTML.
beide gehören zu Ferramenta, unserer kleinen Rust-Werkzeugfamilie ↑
Der native Compiler liest deine Typen. Er hat Ardos eigene API-Dokumentation 4,3× schneller gebaut als TypeDoc.
Der Dev-Server, den du schon kennst. Speichere eine Datei und die Seite aktualisiert sich.
Rust-Werkzeuge, die kompilierte Seiten aufbereiten und deine Deklarationen zuordnen.
dein Designsystem passt hier rein
Komponenten und Layouts
Deine Komponenten sind willkommen.
Binde lokale React-Komponenten oder ein installiertes Designsystem in MDX ein. Baue Startseiten und Layouts in React und ergänze Ardos Karten, Tabs, Schritte, Akkordeons und Hinweise.
API-Referenz für TypeScript
Deine Typen haben jetzt eine Website.
Lass Ardo deine TypeScript-Einstiegspunkte lesen: Daraus entstehen Referenzseiten mit Signaturen, Parametern und Kommentaren. Sie sind auch durchsuchbar und werden beim nächsten Build aktualisiert.
generiert statt von Hand geschrieben
Theming
Mit wenigen Zeilen ganz dein Stil.
Wähle Farben für Marke, Akzente und neutrale Flächen sowie ihre Sättigung. Ardo berechnet daraus Hell- und Dunkelmodus. Du willst mehr? Überschreibe einzelne Tokens oder tausche eine Komponente aus.
Grün · Orange · warmes Grau
Ardos Standard
Blau · Petrol · Schiefer
Dunkelmodus inklusive, für andere Nachteulen
wo Ardo passt
Kennst du eines davon? Dann kennst du Ardo schon fast.
- DocusaurusAuch React und MDX, auf neuerem Fundament: Vite und Rust, mit einfachen HTML-Seiten.
- VitePressAuch Vite und Markdown, mit React statt Vue.
- StarlightAuch statisch und inhaltsorientiert, mit React als Seitenmodell statt als Insel.
- NextraAuch React und MDX, ohne Next.js. Das Ergebnis sind statische Dateien.
- FumadocsAuch React, als Werkzeugkasten. Ardo bietet ein vollständiges Setup mit eigenen Werkzeugen.
- RspressEbenfalls ein Build mit Rust, auf Basis von Rspack. Ardo nutzt Vite und liest dein TypeScript.
- VocsAuch React und Vite. Ardo ergänzt eine generierte API-Referenz und Rust-Werkzeuge.
- DocusDie gleiche Idee für Nuxt und Vue. Ardo ist das React-Gegenstück.
- Material for MkDocsAusgereift und Markdown-orientiert, mit Python. Ardo bleibt bei der React-Toolchain.
- MintlifyEine gehostete Plattform. Ardo ist Open Source und liegt in deinem Repository.
passt das?
Ist Ardo dein Vogel?
Passt gut, wenn
- dein Produkt oder deine Bibliothek mit React und TypeScript gebaut ist
- deine Dokumentation im Repository liegen und durch Reviews gehen soll
- du vorgerenderte Seiten und wenig Arbeit im Browser willst
Eher nicht, wenn
- du nur Text und gar kein React willst (sieh dir Starlight oder VitePress an)
- du gehostete Bearbeitung und Analysen brauchst (dafür gibt es gehostete Plattformen)
wer steckt dahinter?
„Ich habe ein modernes, schlankes Dokumentationsframework gesucht, das einfach React ist. Das gab es nicht. Also habe ich es gebaut.“
SebastianSebastian Werner · Entwickler und Maintainer
- 1. Ein Komponentenmodell. Seiten und Beispiele sind React. Kein zweites UI-Framework.
- 2. Dein Repository ist die Quelle. Inhalte, Konfiguration und Theme gehen durch ein Code-Review.
- 3. Statische Dateien, keine Plattform. Kein Konto, kein Dienst, den du betreiben musst.
- 4. Überprüfbare Aussagen. Öffentlicher Funktionsstatus und veröffentlichte Benchmarks.
Bereit, deine Dokumentation schlüpfen zu lassen?
Ein Satz für deinen Agenten, die offizielle Anleitung, ein getestetes Beispiel. Du prüfst das Ergebnis wie jeden anderen Pull Request.
entwickelt von
Ardo ist Open Source von Sebastian Software, zusammen mit Ferromark, Ferriki und dem Rest der Familie.
brauchst du Hilfe?
Beratung zu TypeScript, React und Rust: Integration, Support und langfristige Wartung von den Menschen, die Ardo entwickeln.