AI Magic 3DDocAvvio rapido
Iniziare con Fumadocs
Introduzione
Fumadocs (Foo-ma docs) è un framework di documentazione **** basato su Next.js, progettato per essere veloce, flessibile, e si compone perfettamente in Next.js App Router.
Fumadocs è composto da diverse parti:
Fumadocs Core
Gestisce la maggior parte della logica, inclusa la ricerca di documenti, gli adattatori delle origini contenuto e le estensioni Markdown.
Fumadocs UI
Il tema predefinito di Fumadocs offre un bell'aspetto per i siti di documentazione e i componenti interattivi.
Content Source
La fonte dei tuoi contenuti può essere un CMS o livelli di dati locali come Raccolte di contenuti e Fumadocs MDX, la fonte di contenuti ufficiale.
Fumadocs CLI
Uno strumento da riga di comando per installare componenti dell'interfaccia utente e automatizzare le cose, utile per personalizzare i layout.
Want to learn more?
Read our in-depth What is Fumadocs introduction.
Terminologia
Markdown/MDX: Markdown è un linguaggio di markup per la creazione di testo formattato. Fumadocs supporta Markdown e MDX (superset di Markdown) immediatamente.
Sebbene non sia necessaria, una conoscenza di base di Next.js App Router sarebbe utile per ulteriori personalizzazioni.
Installazione automatica
È richiesta una versione minima di Node.js 18, tieni presente che Node.js 23.1 potrebbe avere problemi con la build di produzione Next.js.
npm create fumadocs-apppnpm create fumadocs-appyarn create fumadocs-appbun create fumadocs-appTi verrà chiesto il framework e l'origine del contenuto da utilizzare, una nuova app Fumadocs dovrebbe essere inizializzata. Ora puoi iniziare a hackerare!
From Existing Codebase?
Per iniziare è possibile seguire la guida all'installazione manuale.
Divertiti!
Crea il tuo primo file MDX nella cartella documenti.
---
title: Hello World
---
## Yo what's upEsegui l'app in modalità sviluppo e visualizza http://localhost:3000/docs.
npm run devEsplora
Nel progetto puoi vedere:
lib/source.ts: codice per l'adattatore della fonte di contenuto,loader()fornisce un'interfaccia per interagire con la fonte di contenuto e assegna l'URL alle tue pagine.app/layout.config.tsx: opzioni condivise per i layout, facoltative ma preferibili da mantenere.
| Itinerario | Descrizione |
|---|---|
app/(home) | Il gruppo di percorsi per la tua pagina di destinazione e altre pagine. |
app/docs | Il layout e le pagine della documentazione. |
app/api/search/route.ts | Il gestore del percorso per la ricerca. |
Scrittura contenuto
Per creare documenti, assicurati di leggere:
Markdown
Fumadocs has some additional features for authoring content too.
Navigation
Learn how to customise navigation links/sidebar items.
Origine contenuto
L'origine contenuto gestisce tutti i tuoi contenuti, come la compilazione di file Markdown e la convalida del frontmatter.
Leggi l'Introduzione per scoprire come gestisce i tuoi contenuti.
È stato incluso un file di configurazione source.config.ts, puoi personalizzare diverse opzioni come lo schema frontmatter.
Fumadocs non è esclusivo di Markdown. Per altre fonti come Sanity, puoi creare una fonte di contenuto personalizzata.
Personalizza l'interfaccia utente
Consulta la Guida alla personalizzazione.
Domande frequenti
Alcune domande comuni che potresti incontrare.
Tutorial video
Luteriori informazioni
Nuovo qui? Non preoccuparti, siamo i benvenuti per le tue domande.
Se trovi qualcosa di confuso, ti preghiamo di fornire il tuo feedback su Discussione su Github!