AI Magic 3DDocsDémarrage rapide
Premiers pas avec Fumadocs
##Présentation
Fumadocs (Foo-ma docs) est un framework de documentation **** basé sur Next.js, conçu pour être rapide, flexible, et compose de manière transparente dans Next.js App Router.
Fumadocs comporte différentes parties :
Fumadocs Core
Gère la plupart de la logique, y compris la recherche de documents, les adaptateurs de source de contenu et les extensions Markdown.
Fumadocs UI
Le thème par défaut de Fumadocs offre une belle apparence pour les sites de documentation et les composants interactifs.
Content Source
La source de votre contenu peut être un CMS ou des couches de données locales comme Content Collections et Fumadocs MDX, la source de contenu officielle.
Fumadocs CLI
Un outil de ligne de commande pour installer des composants d'interface utilisateur et automatiser les choses, utile pour personnaliser les mises en page.
Want to learn more?
Read our in-depth What is Fumadocs introduction.
Terminologie
Markdown/MDX: Markdown est un langage de balisage permettant de créer du texte formaté. Fumadocs prend en charge Markdown et MDX (sur-ensemble de Markdown) prêts à l'emploi.
Bien que cela ne soit pas obligatoire, certaines connaissances de base de Next.js App Router seraient utiles pour des personnalisations ultérieures.
Installation automatique
Une version minimale de Node.js 18 est requise. Notez que Node.js 23.1 peut rencontrer des problèmes avec la version de production de Next.js.
npm create fumadocs-apppnpm create fumadocs-appyarn create fumadocs-appbun create fumadocs-appIl vous demandera le framework et la source de contenu à utiliser, une nouvelle application fumadocs devra être initialisée. Vous pouvez maintenant commencer à pirater !
From Existing Codebase?
Vous pouvez suivre le guide Installation manuelle pour commencer.
Profitez-en !
Créez votre premier fichier MDX dans le dossier docs.
---
title: Hello World
---
## Yo what's upExécutez l'application en mode développement et voyez http://localhost:3000/docs.
npm run devExplorer
Dans le projet, vous pouvez voir :
lib/source.ts: code pour l'adaptateur de source de contenu,loader()fournit une interface pour interagir avec votre source de contenu et attribue une URL à vos pages.app/layout.config.tsx: options partagées pour les mises en page, facultatives mais préférables à conserver.
| Itinéraire | Descriptif |
|---|---|
app/(home) | Le groupe de routage pour votre page de destination et d'autres pages. |
app/docs | La présentation et les pages de la documentation. |
app/api/search/route.ts | Le gestionnaire de route pour la recherche. |
Rédaction de contenu
Pour la création de documents, assurez-vous de lire :
Markdown
Fumadocs has some additional features for authoring content too.
Navigation
Learn how to customise navigation links/sidebar items.
Source de contenu
La source de contenu gère tout votre contenu, comme la compilation des fichiers Markdown et la validation du frontmatter.
Lisez l'Introduction pour savoir comment il gère votre contenu.
Un fichier de configuration source.config.ts a été inclus, vous pouvez personnaliser différentes options comme le schéma frontmatter.
Fumadocs n'est pas exclusif à Markdown. Pour d'autres sources comme Sanity, vous pouvez créer une source de contenu personnalisée.
Personnaliser l'interface utilisateur
Voir Guide de personnalisation.
##FAQ
Quelques questions courantes que vous pourriez rencontrer.
Tutoriels vidéo
Len savoir plus
Nouveau ici ? Ne vous inquiétez pas, nous sommes les bienvenus pour vos questions.
Si vous trouvez quelque chose de déroutant, veuillez donner votre avis sur Github Discussion !