Fumadocs

Fumadocs è un framework per la documentazione che aiuta gli sviluppatori a creare siti di documentazione professionali utilizzando React e Next.js. A differenza degli strumenti di documentazione tradizionali, ti offre il completo controllo sul contenuto e sul design, gestendo automaticamente le parti più complesse.

Supporta la scrittura di contenuti in Markdown e MDX, il che significa che puoi utilizzare una semplice formattazione del testo o aggiungere componenti React interattivi. Il framework include una ricerca integrata, evidenziazione della sintassi e bellissimi temi predefiniti. Funziona inoltre con qualsiasi fonte di contenuti, che tu memorizzi i tuoi documenti in file, in un database o in un sistema di gestione dei contenuti.

Fumadocs è costruito su tre parti: un livello di contenuto per gestire i tuoi documenti, una libreria core per funzionalità come la ricerca e una libreria UI per componenti belli. Puoi usare solo ciò di cui hai bisogno.

Iniziare con Fumadocs è semplice. Ecco i passaggi:

• Installa il framework eseguendo il comando npm create fumadocs-app nel tuo terminale. Scegli il framework React preferito e la fonte dei contenuti quando richiesto.

• Scrivi i tuoi contenuti in file MDX all'interno della cartella docs. Usa una sintassi Markdown semplice con l'opzione di aggiungere componenti React per elementi interattivi.

• Personalizza l'aspetto utilizzando Tailwind CSS. Puoi cambiare colori, layout e stili per adattarli al tuo brand senza dover imparare un nuovo sistema.

• Aggiungi la funzionalità di ricerca collegando Orama o Algolia con poche righe di codice. Il framework gestisce automaticamente il resto.

• Usa lo strumento CLI per aggiungere componenti interattivi come tab, callout e blocchi di codice con il comando npx @fumadocs/cli add.

• Distribuisci il tuo sito su Vercel, Netlify o qualsiasi servizio di hosting che supporti applicazioni Next.js.

• Framework gratuito e open-source

• Funziona con Next.js, React Router e altri framework React

• Scrivi contenuti in Markdown e MDX

• Ricerca integrata con supporto Orama e Algolia

• Generatore di documentazione OpenAPI

• Integrazione TypeScript Twoslash

• Bellissimi componenti UI pre-progettati

• Strumento da linea di comando per una configurazione semplice

• Evidenziazione della sintassi con Shiki

• Altamente personalizzabile con Tailwind CSS