Introduction
⚡️ Docusaurus vous aidera à mettre en place un beau site de documentation en un rien de temps.
💸 La construction d'une pile de technologies personnalisées est coûteuse. Au lieu de cela, mettez l'accent sur votre contenu et écrivez simplement des fichiers Markdown.
💥 Vous en voulez plus ? Utilisez les fonctionnalités avancées comme la gestion des versions, i18n, la recherche et les personnalisations de thèmes.
💅 Consultez les meilleurs sites Docusaurus pour vous inspirer et lisez quelques témoignages.
🧐 Docusaurus est un générateur de site statique. Il construit une application mono-page avec une navigation rapide côté client, en exploitant toute la puissance de React pour rendre votre site interactif. Il fournit des fonctionnalités de documentation prêtes à l'emploi mais peut être utilisé pour créer tout type de site (site web personnel, de produit, blog, pages de présentation de marketing, etc).
Procédure accélérée ⏱️
Découvrez Docusaurus en 5 minutes en jouant !
Créez un nouveau site Docusaurus et suivez le très court tutoriel intégré.
Installez Node.js et créez un nouveau site Docusaurus :
npx create-docusaurus@latest my-website classic
Démarrez le site :
cd my-website
npx docusaurus start
Ouvrez http://localhost:3000
et suivez le tutoriel.
Utilisez docusaurus.new pour tester immédiatement Docusaurus dans votre navigateur !
Ou lisez le tutoriel de 5 minutes en ligne.
Docusaurus : la documentation en toute simplicité
Dans cette présentation à l'événement communautaire d'Algolia, l'équipe Open Source de Meta a partagé un bref aperçu de Docusaurus. Ils ont décrit comment démarrer avec le projet, activer les plugins, et mettre en place des fonctionnalités telles que la documentation et le blog.
Migration depuis la v1
Docusaurus v2 a été totalement réécrit à partir de Docusaurus v1, profitant d'une chaîne d'outils complètement modernisée. Après la sortie officielle de v2, nous vous encourageons vivement à utiliser Docusaurus v2 plutôt que Docusaurus v1, car Docusaurus v1 a été déprécié.
Beaucoup d'utilisateurs exploitent déjà Docusaurus v2 (tendances).
Utilisez Docusaurus v2 si :
- ✅ Vous voulez un site de documentation Jamstack moderne
- ✅ Vous voulez une single-page-application (SPA) avec un routage côté client
- ✅ Vous voulez la pleine puissance de React et MDX
- ✅ Vous n'avez pas besoin de support pour IE11
Utilisez Docusaurus v2 si :
- ❌ Vous ne voulez pas de single-page-application (SPA)
- ❌ Vous avez besoin de support pour IE11 (...n'est-ce pas ? IE a déjà atteint sa fin de vie et n'est plus officiellement pris en charge)
Pour les utilisateurs de la v1 existants qui cherchent à passer à la v2, vous pouvez suivre notre guide de migration.