Ga naar de inhoud

Inleiding

Bekijken als Markdown Bewerken op GitHub Documentatie op 7b38e05

Onedocs is een verzameling layouts, componenten en helpers voor documentatiesites gebouwd met Next.js en Fumadocs. U schrijft Markdown, beschrijft uw site in één configuratiebestand, en Onedocs levert de documentatieschil, een startpagina en de routes voor SEO.

Het is bedoeld voor zelfstandige documentatiewebsites, niet om documentatie aan een bestaande applicatie toe te voegen.

Wat Onedocs toevoegt

Boven op Fumadocs biedt het pakket onedocs u:

  • Layouts - DocsLayout en DocsPage bevatten de documentatielayout Fumadocs UI, met zijbalk, zoeken, themaschakelaar en inhoudsopgave. HomePage geeft een landingspagina weer met hero, installatieopdrachten, functies en voettekst.
  • Eén configuratiebestand - onedocs.config.ts bevat de titel, beschrijving, het logo, het favicon, navigatielinks, de voettekst en de inhoud van de startpagina.
  • Componenten van MDX - mdxComponents registreert toelichtingen, tabbladen, kaarten, stappen, accordeons, bestandsstructuren, afbeeldingszoom en typetabellen, zodat pagina's ze zonder imports kunnen gebruiken.
  • Preset voor CSS - één import voegt Tailwind CSS v4, het thema Fumadocs UI en de layoutstijlen Onedocs toe.
  • Helpers van SEO - functies voor sitemap.xml, robots.txt, llms.txt, llms-full.txt, paginametadata en Open Graph-afbeeldingen.

Wat u zelf instelt

Onedocs bevat Next.js of Fumadocs niet. Dit zijn peer dependencies die u ernaast installeert:

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

U hebt ook Tailwind CSS v4, Node.js 20.9 of hoger en ongeveer tien kleine bestanden nodig: de configuratie Next.js en Fumadocs MDX, een contentbron, de hoofdlayout, de documentatielayout en de documentatieroute. In Aan de slag vindt u uitleg over elk bestand.

Waar u instellingen configureert

Wat Waar
Sitetitel, logo, navigatie, voettekst onedocs.config.ts, zie Configuratie
Hero en functies van de startpagina homepage in onedocs.config.ts, weergegeven door HomePage in src/app/page.tsx
Documentatielayout en -pagina's src/app/docs/layout.tsx en src/app/docs/[[...slug]]/page.tsx, zie Aan de slag
Contentmap en volgorde van de zijbalk source.config.ts en content/docs/meta.json
Componenten van MDX mdxComponents, zie Componenten
Zoeken, sitemap, robots.txt, llms.txt Routerbestanden onder src/app/, zie SEO en zoeken
Metadata en Open Graph-afbeeldingen onedocs/metadata en onedocs/og, zie API-referentie

Filosofie

  • Markdown eerst - Schrijf .md of .mdx en krijg documentatie
  • Eén configuratiebestand - De sitebrede instellingen staan in onedocs.config.ts
  • Uitwijkmogelijkheden - Meer controle nodig? Gebruik Fumadocs rechtstreeks

Begin hier