Présentation
Fumadocs (Foo-ma docs) est un cadre de documentation basé sur Next.js. Il est rapide, souple, et s’intègre naturellement au routeur App de Next.js.
Fumadocs se compose de plusieurs parties :
Noyau de Fumadocs
Il prend en charge l’essentiel de la logique : recherche dans les documents, adaptateurs de source de contenu et extensions Markdown.
Interface Fumadocs
Le thème par défaut de Fumadocs donne aux sites de documentation un rendu soigné et des composants interactifs.
Source de contenu
L’origine de votre contenu : un CMS ou une couche locale, comme Fumadocs MDX (la source officielle).
CLI Fumadocs
Un outil en ligne de commande pour installer des composants d’interface et automatiser certaines tâches, notamment la personnalisation des mises en page.
Vous voulez aller plus loin ?
Lisez notre présentation détaillée Qu’est-ce que Fumadocs.
Terminologie
Markdown/MDX : Markdown est un langage de balisage pour mettre en forme du texte. Fumadocs prend en charge Markdown et MDX (sur-ensemble de Markdown) sans configuration supplémentaire.
Ce n’est pas obligatoire, mais quelques bases du routeur App de Next.js aident pour aller plus loin dans la personnalisation.
Installation automatique
Node.js 18 au minimum est requis. Node.js 23.1 peut poser problème avec le build de production de Next.js.
npm create fumadocs-appIl vous demandera :
- le cadre React.js à utiliser (la documentation n’est écrite que pour Next.js) ;
- la source de contenu à utiliser.
Une nouvelle application Fumadocs est alors initialisée. Vous pouvez commencer à la modifier.
Depuis une base de code existante ?
Suivez le guide Installation manuelle pour démarrer.
À vous de jouer
Créez votre premier fichier MDX dans le dossier docs.
---
title: Hello World
---
## Yo what's upLancez l’application en mode développement et ouvrez http://localhost:3000/docs.
npm run devQuestions fréquentes
Quelques questions qui reviennent souvent.
Mettre Fumadocs à jour
Mettez Fumadocs à jour lorsque vous rencontrez un problème ou que vous voulez essayer une nouveauté :
pnpm update -i -r --latestPour aller plus loin
Vous débutez ? Posez vos questions, nous les accueillons volontiers.
Si un point reste obscur, dites-le sur GitHub Discussions.
Rédiger le contenu
Pour rédiger la documentation, lisez aussi :
Markdown
Fumadocs ajoute quelques fonctions utiles pour rédiger le contenu.
Navigation
Personnalisez les liens de navigation et les éléments de la barre latérale.
Routage
Organisez le contenu.
Composants
Voir les composants disponibles pour enrichir vos docs