Fumadocs

Fumadocs est un cadre de documentation qui aide les développeurs à créer des sites de documentation professionnels en utilisant React et Next.js. Contrairement aux outils de documentation traditionnels, il vous donne un contrôle total sur votre contenu et votre design tout en gérant automatiquement les parties complexes.

Il prend en charge l’écriture de contenu en Markdown et MDX, ce qui signifie que vous pouvez utiliser une mise en forme de texte simple ou ajouter des composants React interactifs. Le cadre inclut une recherche intégrée, la coloration syntaxique et de magnifiques thèmes préconçus. Il fonctionne également avec n’importe quelle source de contenu, que vous stockiez vos documents dans des fichiers, une base de données ou un système de gestion de contenu.

Fumadocs est construit autour de trois parties : une couche de contenu pour gérer vos documents, une bibliothèque centrale pour des fonctionnalités comme la recherche, et une bibliothèque UI pour de beaux composants. Vous pouvez utiliser uniquement ce dont vous avez besoin.

Commencer avec Fumadocs est simple. Voici les étapes :

• Installez le framework en exécutant la commande npm create fumadocs-app dans votre terminal. Choisissez votre framework React préféré et la source de contenu lorsque cela vous est demandé.

• Rédigez votre contenu dans des fichiers MDX à l'intérieur du dossier docs. Utilisez une syntaxe Markdown simple avec la possibilité d'ajouter des composants React pour des éléments interactifs.

• Personnalisez l'apparence en utilisant Tailwind CSS. Vous pouvez changer les couleurs, les mises en page et les styles pour correspondre à votre marque sans apprendre un nouveau système.

• Ajoutez une fonctionnalité de recherche en connectant Orama ou Algolia avec seulement quelques lignes de code. Le framework s'occupe du reste automatiquement.

• Utilisez l'outil CLI pour ajouter des composants interactifs comme des onglets, des encadrés d'appel et des blocs de code avec la commande npx @fumadocs/cli add.

• Déployez votre site sur Vercel, Netlify ou tout service d'hébergement supportant les applications Next.js.

• Cadre gratuit et open-source

• Fonctionne avec Next.js, React Router et autres frameworks React

• Écrivez du contenu en Markdown et MDX

• Recherche intégrée avec support Orama et Algolia

• Générateur de documentation OpenAPI

• Intégration TypeScript Twoslash

• Beaux composants UI préconçus

• Outil en ligne de commande pour une configuration facile

• Mise en évidence de la syntaxe avec Shiki

• Hautement personnalisable avec Tailwind CSS