Gå til indhold

Introduktion

Vis som Markdown Rediger på GitHub Dokumentation hos 7b38e05

Onedocs er et sæt layouts, komponenter og hjælpefunktioner til dokumentationswebsteder bygget med Next.js og Fumadocs. Du skriver Markdown, beskriver dit websted i én konfigurationsfil, og Onedocs leverer dokumentationsskallen, en startside og ruterne SEO.

Det er beregnet til selvstændige dokumentationswebsteder, ikke til at føje dokumentation til en eksisterende app.

Hvad Onedocs tilføjer

Oven på Fumadocs giver pakken onedocs dig:

  • Layouts - DocsLayout og DocsPage omslutter dokumentationslayoutet Fumadocs UI med sidepanel, søgning, temaskift og indholdsfortegnelse. HomePage gengiver en landingsside med hero-sektion, installationskommandoer, funktioner og sidefod.
  • Én konfigurationsfil - onedocs.config.ts indeholder titel, beskrivelse, logo, favicon, navigationslinks, sidefod og startsidens indhold.
  • MDX-komponenter - mdxComponents registrerer fremhævede bokse, faner, kort, trin, harmonikaer, filtræer, billedzoom og typetabeller, så siderne kan bruge dem uden importer.
  • Forudindstilling af CSS - én import indlæser Tailwind CSS v4, temaet Fumadocs UI og layouttypografierne Onedocs.
  • Hjælpefunktioner til SEO - funktioner til sitemap.xml, robots.txt, llms.txt, llms-full.txt, sidemetadata og Open Graph billeder.

Det skal du selv konfigurere

Onedocs inkluderer ikke Next.js eller Fumadocs. De er peer-afhængigheder, som du installerer ved siden af:

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

Du skal også bruge Tailwind CSS v4, Node.js 20.9 eller nyere og omkring ti små filer: Next.js- og Fumadocs MDX-konfigurationen, en indholdskilde, rodlayoutet, dokumentationslayoutet og dokumentationssidens rute. Kom godt i gang gennemgår dem alle.

Hvor ting konfigureres

Hvad Hvor
Webstedets titel, logo, navigation, sidefod onedocs.config.ts, se Konfiguration
Startsiden: hero-sektion og funktioner homepage i onedocs.config.ts, gengivet af HomePage i src/app/page.tsx
Dokumentationslayout og sider src/app/docs/layout.tsx og src/app/docs/[[...slug]]/page.tsx, se Kom godt i gang
Indholdsmappe og rækkefølge i sidepanelet source.config.ts og content/docs/meta.json
MDX-komponenter mdxComponents, se Komponenter
Søgning, sitemap, robots.txt, llms.txt Rutefiler under src/app/, se SEO og søgning
Metadata og Open Graph billeder onedocs/metadata og onedocs/og, se API-referencen

Filosofi

  • Markdown-first – Skriv .md eller .mdx for at få dokumentation
  • Én konfigurationsfil – Indstillinger for hele webstedet findes i onedocs.config.ts
  • Flugtveje – Har du brug for mere kontrol? Brug Fumadocs direkte

Start her