Présentation d'Explainer v2

Nous sommes ravis d’annoncer Explainer v2 — une réécriture complète de notre boilerplate de documentation, désormais construit sous forme de monorepo propulsé par Astro, React, Tailwind CSS 4 et pnpm. Il embarque trois applications indépendantes — docs, blog et website — qui partagent des packages communs pour le rendu MDX, les composants UI et la configuration.

Que vous documentiez une simple bibliothèque ou tout un écosystème de projets, Explainer v2 vous fournit tout ce dont vous avez besoin, clé en main.

Pourquoi Explainer ?

Le problème

L’outillage de documentation est fragmenté. Vous avez besoin d’un outil pour la doc, un autre pour votre blog, un autre pour votre landing page — chacun avec sa propre configuration, son pipeline de build et sa stratégie de déploiement. Maintenir la cohérence est un fardeau.

Explainer résout ce problème en vous offrant un monorepo unique et prêt à l’emploi où docs, blog et site web coexistent. Des packages partagés assurent un style cohérent et des composants MDX identiques dans les trois applications, tout en permettant un déploiement indépendant de chacune.

Fonctionnalités clés

Explainer v2 est livré avec des fonctionnalités conçues pour les besoins réels de documentation :

Docs multi-projets

Hébergez la documentation de plusieurs projets dans une seule instance. Chaque projet dispose de sa propre barre latérale, de son versioning et de sa navigation — accessible via un sélecteur déroulant.

Versioning

Publiez la documentation pour plusieurs versions de votre projet. Utilisez default pour les docs sans version, ou ajoutez des versions nommées comme v1, v2 — les lecteurs passent de l’une à l’autre en toute fluidité.

Internationalisation

Support complet de l’i18n avec routage par préfixe URL (/fr/..., /en/...), détection automatique de la langue du navigateur et navigation par locale.

Recherche plein texte

Recherche intégrée propulsée par Pagefind. Vos docs sont indexées au moment du build — aucun service externe requis, entièrement statique et ultra rapide.

Miniatures OG

Génération automatique d’images Open Graph pour chaque page de documentation, offrant des aperçus enrichis lors du partage sur les réseaux sociaux.

Composants MDX enrichis

Explainer v2 est livré avec une bibliothèque de composants MDX personnalisés qui sont auto-importés dans chaque fichier de contenu — aucune instruction d’import nécessaire. Voici un aperçu :

Ce callout a été écrit avec une simple directive — pas d’imports, pas de boilerplate. Le pipeline MDX d’Explainer gère tout pour vous.

Callouts

Variantes info, success, warning, danger et note pour mettre en avant le contenu important.

Cards & Card Groups

Cartes visuelles avec icônes et liens, disposées dans des grilles responsives.

Blocs de code

Coloration syntaxique, numéros de ligne, mise en surbrillance de lignes, groupes de code avec onglets, et plus encore.

Vous disposez également de composants Tabs, Steps, Code Groups et Preview — tous documentés dans la référence des composants.

Trois apps, un monorepo

App	Rôle	Port	Package
Docs	Documentation technique avec navigation latérale, versioning et recherche	`4321`	`@explainer/docs`
Blog	Blog orienté contenu avec tags, auteurs et RSS	`4322`	`@explainer/blog`
Website	Landing page marketing	`4323`	`@explainer/website`

Les trois applications partagent des packages communs pour le traitement MDX, les composants UI et la configuration Tailwind. En savoir plus sur la structure du projet.

Démarrage rapide

Cloner le dépôt

git clone https://github.com/explainer/explainer-v2
cd explainer-v2

Installer les dépendances

Explainer utilise les workspaces pnpm. Installez tout avec une seule commande :

pnpm install

Commencer à développer

Lancez les trois applications en mode développement :

pnpm dev

Ou lancez une seule application :

pnpm dev --filter @explainer/docs

Pour le guide complet d’installation, y compris les prérequis et la configuration, rendez-vous sur la page Démarrage rapide.

Déployer partout

Les applications Explainer v2 sont des projets Astro standards — déployez-les où vous voulez :

Docker

Conteneurisez chaque application indépendamment grâce aux Dockerfiles et au setup docker-compose inclus.

Vercel

Déploiement zéro-config avec builds automatiques et environnements de prévisualisation.

Cloudflare Pages

Déployez sur le réseau edge de Cloudflare pour des performances mondiales.

GitHub Pages

Hébergement gratuit avec GitHub Actions pour des builds automatisés à chaque push.

Et ensuite

Explainer v2 est prêt à être utilisé dès aujourd’hui. Nous travaillons activement à enrichir les fonctionnalités — mais les fondations sont solides et prêtes pour la production.

Explorez la documentation

Rendez-vous sur la documentation pour commencer, ou parcourez les pages de fonctionnalités pour découvrir tout ce qu’Explainer v2 a à offrir.

Si vous trouvez Explainer utile, mettez-nous une étoile sur GitHub et partagez-le avec votre équipe. Nous serions ravis de voir ce que vous construisez avec !