La documentation React, servie en HTML.
Ardo est un générateur de sites statiques pour les projets React. Des guides en Markdown et MDX, une référence API issue de votre TypeScript et une recherche, le tout prérendu avec Rust lors du build.
← actualisé depuis npm à chaque build
vos dossiers deviennent cette barre
coloré lors du build
comment ça marche
Du dépôt au site web, sans serveur à gérer.
Écrire
- Guides en Markdown et MDX
- Vos propres composants et mises en page
- Référence API issue de TypeScript
- Collections de contenu typées
Compiler
Les outils Rust compilent votre Markdown et colorent chaque bloc de code, TypeScript 7 lit vos types et Vite assemble le reste. L’index de recherche, le sitemap et llms.txt sortent du même four.
Publier
Chaque page est un document HTML complet. Les moteurs de recherche voient tout, les lecteurs accèdent au contenu dès la première requête, et n’importe quel hébergement statique convient.
pour commencer simplement
Confiez l’installation à votre agent.
Pas de modèle de départ ni de marathon de copier-coller. Donnez cette phrase à votre agent de développement, dans un dépôt neuf ou existant. Le lien le dirige vers les instructions officielles d’Ardo. Il adapte l’exemple testé et vous indique le résultat du contrôle des types, des tests et du build. Vous relisez le tout comme n’importe quelle pull request.
Installe Ardo dans ce dépôt en suivant https://
oui, c’est tout le prompt. le temps de prendre un café.
sous le capot
Rapide de bout en bout.
Ardo repose sur des outils remarquables. Deux d’entre eux viennent de notre propre atelier, écrits en Rust.
Ferromark
Notre compilateur Markdown et MDX. Il transforme les pages en composants React et en extrait les titres, le sommaire et les données de recherche.
2,6× plus rapide que pulldown-cmark sur 50 documents réels.
Ferriki
Notre outil de coloration syntaxique. Chaque bloc de code reçoit ses couleurs lors du build, en clair et en sombre. Le navigateur n’a plus rien à calculer.
4,7× plus rapide que Shiki sur WebAssembly, avec le même HTML.
les deux font partie de Ferramenta, notre petite famille d’outils Rust ↑
Le compilateur natif lit vos types. Il a généré la documentation API d’Ardo 4,3× plus vite que TypeDoc.
Le serveur de développement que vous connaissez déjà. Enregistrez un fichier, la page se met à jour.
Des outils Rust qui optimisent les pages compilées et associent vos déclarations.
votre design system a sa place ici
composants et mises en page
Vos composants sont les bienvenus.
Intégrez des composants React locaux ou un design system installé dans MDX. Créez vos pages d’accueil et mises en page en React, avec les cartes, onglets, étapes, accordéons et encadrés d’Ardo.
Référence API pour TypeScript
Vos types ont désormais leur site.
Indiquez à Ardo vos points d’entrée TypeScript pour générer des pages de référence avec signatures, paramètres et commentaires. Elles sont aussi indexées par la recherche et actualisées au prochain build.
généré, pas écrit à la main
thèmes
Quelques lignes pour lui donner votre style.
Choisissez les teintes de marque, d’accent et neutre, ainsi que leur saturation. Ardo en déduit les modes clair et sombre. Besoin de plus ? Redéfinissez un token ou remplacez un composant.
vert · orange · gris chaud
Le thème par défaut d’Ardo
bleu · bleu canard · ardoise
mode sombre inclus, pour les oiseaux de nuit
la place d’Ardo
Vous connaissez l’un de ces outils ? Alors vous connaissez presque Ardo.
- DocusaurusReact et MDX aussi, sur une base plus récente : Vite et Rust, avec des pages HTML.
- VitePressVite et Markdown aussi, avec React à la place de Vue.
- StarlightStatique et centré sur le contenu aussi, avec React comme modèle de page, pas comme îlot.
- NextraReact et MDX aussi, sans Next.js. Le résultat : des fichiers statiques.
- FumadocsReact aussi, sous forme de boîte à outils. Ardo propose une installation complète avec ses propres outils.
- RspressUn build propulsé par Rust, avec Rspack. Ardo utilise Vite et lit votre TypeScript.
- VocsReact et Vite aussi. Ardo ajoute une référence API générée et des outils Rust.
- DocusLa même idée pour Nuxt et Vue. Ardo en est l’équivalent React.
- Material for MkDocsUn outil éprouvé, centré sur Markdown, en Python. Ardo reste dans l’écosystème React.
- MintlifyUne plateforme hébergée. Ardo est open source et reste dans votre dépôt.
est-ce pour vous ?
Ardo est-il fait pour vous ?
Un bon choix si
- votre produit ou bibliothèque utilise React et TypeScript
- votre documentation doit rester dans le dépôt et passer en revue
- vous souhaitez des pages prérendues et peu de travail côté navigateur
Peut-être pas si
- vous voulez du texte uniquement, sans React (essayez Starlight ou VitePress)
- vous avez besoin d’édition et d’analyses hébergées (une plateforme hébergée s’en charge)
qui a créé tout ça ?
« Je cherchais un framework de documentation moderne et léger, tout simplement en React. Il n’existait pas. Alors je l’ai créé. »
SebastianSebastian Werner · créateur et mainteneur
- 1. Un seul modèle de composants. Les pages et les exemples sont en React. Aucun second framework d’interface.
- 2. Votre dépôt fait foi. Le contenu, la configuration et le thème passent en revue de code.
- 3. Des fichiers statiques, sans plateforme. Aucun compte, aucun service à maintenir.
- 4. Des affirmations vérifiables. Un état public des fonctionnalités et des benchmarks publiés.
Prêt à faire éclore votre documentation ?
Une phrase pour votre agent, les instructions officielles, un exemple testé. Vous relisez le résultat comme n’importe quelle pull request.
créé par
Ardo est un projet open source de Sebastian Software, aux côtés de Ferromark, Ferriki et du reste de la famille.
besoin d’un coup de main ?
Conseil TypeScript, React et Rust : intégration, assistance et maintenance à long terme par les personnes qui développent Ardo.