Docusaurus

Docusaurus est un générateur de sites statiques construit avec React et Node.js. Il prend vos fichiers Markdown et crée un site complet de documentation avec toutes les fonctionnalités attendues par les utilisateurs. Contrairement à la création d’un site web à partir de zéro, Docusaurus gère les parties difficiles pour vous.

L’outil utilise MDX, ce qui signifie que vous pouvez ajouter des composants React interactifs directement dans vos fichiers Markdown. Cela rend votre documentation plus attrayante sans travail supplémentaire. Il est livré avec une recherche intégrée alimentée par Algolia, une gestion des versions pour différentes sorties de produits, et un support pour plus de 70 langues grâce aux outils de traduction.

Parce qu’il crée des fichiers statiques, votre documentation se charge rapidement et peut être hébergée n’importe où. Les sites fonctionnent parfaitement sur les appareils mobiles et respectent les normes web modernes en matière de vitesse et d’accessibilité.

Commencer avec Docusaurus est simple et ne prend que quelques minutes :

• Installez Node.js version 20 ou supérieure sur votre ordinateur, puis exécutez la commande d'installation dans votre terminal pour créer un nouveau site.

• Rédigez votre documentation dans des fichiers Markdown à l'intérieur du dossier docs. Chaque fichier devient une page de votre site web.

• Personnalisez l'apparence en modifiant le fichier de configuration. Vous pouvez changer les couleurs, ajouter votre logo et configurer les menus de navigation.

• Utilisez la commande de prévisualisation locale pour voir les modifications instantanément dans votre navigateur pendant que vous travaillez.

• Ajoutez des articles de blog en créant des fichiers Markdown dans le dossier blog avec des dates dans le nom de fichier.

• Lorsque vous êtes prêt à publier, exécutez la commande de build pour générer des fichiers statiques, puis téléchargez-les sur n'importe quel hébergeur web comme GitHub Pages, Netlify ou Vercel.

L'outil inclut des guides détaillés et une communauté utile si vous rencontrez des difficultés.

• Gratuit et open source avec licence MIT

• Construit avec React et Node.js

• Rédigez du contenu en Markdown et MDX

• Recherche intégrée avec Algolia DocSearch

• Gestion des versions pour les sorties de produits

• Support de plus de 70 langues

• Blog et documentation sur un même site

• Mode sombre et design responsive

• Génération rapide de sites statiques

• Déploiement facile sur n’importe quel hébergeur