Vai al contenuto

Introduzione

Visualizza come Markdown Modifica su GitHub Documentazione di 7b38e05

Onedocs è un insieme di layout, componenti e helper per siti di documentazione realizzati con Next.js e Fumadocs. Scrivete Markdown, descrivete il sito in un unico file di configurazione e Onedocs fornisce la struttura della documentazione, una home page e le route SEO.

È pensato per siti di documentazione autonomi, non per aggiungere documentazione a un'applicazione esistente.

Cosa aggiunge Onedocs

Oltre a Fumadocs, il pacchetto onedocs offre:

  • Layout - DocsLayout e DocsPage racchiudono il layout di documentazione Fumadocs UI, con barra laterale, ricerca, selettore del tema e indice. HomePage visualizza una pagina iniziale con sezione principale, comandi di installazione, funzionalità e piè di pagina.
  • Un solo file di configurazione - onedocs.config.ts contiene titolo, descrizione, logo, favicon, collegamenti di navigazione, piè di pagina e contenuti della home page.
  • Componenti MDX - mdxComponents registra riquadri informativi, schede, card, passaggi, fisarmoniche, alberi di file, zoom delle immagini e tabelle di tipi, così le pagine li usano senza importazioni.
  • Preset CSS - una sola importazione include Tailwind CSS v4, il tema Fumadocs UI e gli stili del layout Onedocs.
  • Helper SEO - funzioni per sitemap.xml, robots.txt, llms.txt, llms-full.txt, i metadati delle pagine e le immagini Open Graph.

Cosa configurare autonomamente

Onedocs non include Next.js né Fumadocs. Sono dipendenze peer da installare accanto al pacchetto:

Shell
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

Servono anche Tailwind CSS v4, Node.js 20.9 o versioni successive e circa dieci file semplici: la configurazione Next.js e Fumadocs MDX, una sorgente dei contenuti, il layout principale, il layout della documentazione e la route della pagina di documentazione. Introduzione li illustra tutti.

Dove si configura ogni elemento

Elemento Posizione
Titolo del sito, logo, navigazione, piè di pagina onedocs.config.ts, vedi Configurazione
Sezione principale e funzionalità della home page homepage in onedocs.config.ts, visualizzate da HomePage in src/app/page.tsx
Layout e pagine della documentazione src/app/docs/layout.tsx e src/app/docs/[[...slug]]/page.tsx, vedi Introduzione
Cartella dei contenuti e ordine della barra laterale source.config.ts e content/docs/meta.json
Componenti MDX mdxComponents, vedi Componenti
Ricerca, sitemap, robots.txt, llms.txt File di route in src/app/, vedi SEO e ricerca
Metadati e immagini Open Graph onedocs/metadata e onedocs/og, vedi API Reference

Filosofia

  • Markdown prima di tutto - Scrivete .md o .mdx e ottenete la documentazione
  • Un solo file di configurazione - Le impostazioni globali del sito si trovano in onedocs.config.ts
  • Possibilità di personalizzazione - Serve più controllo? Usate direttamente Fumadocs

Iniziate da qui