Hoppa till innehåll

Introduktion

Visa som Markdown Redigera på GitHub Dokumentation på 7b38e05

Onedocs är en uppsättning layouter, komponenter och hjälpfunktioner för dokumentationswebbplatser byggda med Next.js och Fumadocs. Du skriver Markdown, beskriver webbplatsen i en enda konfigurationsfil, och Onedocs tillhandahåller dokumentationsramverket, en startsida och SEO-routes.

Det är avsett för fristående dokumentationswebbplatser, inte för att lägga till dokumentation i ett befintligt program.

Vad Onedocs tillför

Utöver Fumadocs ger paketet onedocs dig:

  • Layouter - DocsLayout och DocsPage omsluter dokumentationslayouten Fumadocs UI med sidofält, sök, temaväxling och innehållsförteckning. HomePage renderar en landningssida med huvudsektion, installationskommandon, funktioner och sidfot.
  • En konfigurationsfil - onedocs.config.ts innehåller titel, beskrivning, logotyp, favicon, navigeringslänkar, sidfot och startsidans innehåll.
  • MDX-komponenter - mdxComponents registrerar informationsrutor, flikar, kort, steg, dragspel, filträd, bildzoom och typinformationstabeller, så att sidor kan använda dem utan importer.
  • Förinställningen CSS - en enda import tar in Tailwind CSS v4, temat Fumadocs UI och layoutstilarna Onedocs.
  • Hjälpfunktioner för SEO - funktioner för sitemap.xml, robots.txt, llms.txt, llms-full.txt, sidmetadata och Open Graph-bilder.

Vad du konfigurerar själv

Onedocs paketerar inte Next.js eller Fumadocs. De är peer-beroenden som du installerar bredvid det:

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

Du behöver också Tailwind CSS v4, Node.js 20.9 eller senare och ungefär tio små filer: konfigurationen Next.js och Fumadocs MDX, en innehållskälla, rotlayouten, dokumentationslayouten och dokumentationssidans route. Komma igång visar varje fil.

Var inställningarna görs

Vad Var
Webbplatstitel, logotyp, navigering, sidfot onedocs.config.ts, se Konfiguration
Startsida med hero och funktioner homepage i onedocs.config.ts, renderad av HomePage i src/app/page.tsx
Dokumentationslayout och sidor src/app/docs/layout.tsx och src/app/docs/[[...slug]]/page.tsx, se Kom igång
Innehållsmapp och ordning i sidofältet source.config.ts och content/docs/meta.json
MDX-komponenter mdxComponents, se Komponenter
Sökning, webbplatskarta, robots.txt, llms.txt Routfiler under src/app/, se SEO och sökning
Metadata och Open Graph-bilder onedocs/metadata och onedocs/og, se API-referens

Filosofi

  • Markdown först – Skriv .md eller .mdx, få dokumentation
  • En konfigurationsfil – Inställningar för hela webbplatsen finns i onedocs.config.ts
  • Möjlighet till direkt kontroll – Behöver du mer kontroll? Använd Fumadocs direkt

Börja här