Treci la conținut

Introducere

Vizualizați ca Markdown Editați pe GitHub Documentație la 7b38e05

Onedocs este un set de layouturi, componente și funcții ajutătoare pentru site-uri de documentație create cu Next.js și Fumadocs. Scrieți Markdown, descrieți site-ul într-un singur fișier de configurare, iar Onedocs furnizează structura documentației, o pagină principală și rutele SEO.

Este destinat site-urilor de documentație independente, nu adăugării documentației într-o aplicație existentă.

Ce adaugă Onedocs

Pe lângă Fumadocs, pachetul onedocs vă oferă:

  • Layouturi - DocsLayout și DocsPage încadrează layoutul de documentație Fumadocs UI, cu bară laterală, căutare, comutator de temă și cuprins. HomePage randează o pagină de prezentare cu secțiunea principală, comenzi de instalare, funcționalități și subsol.
  • Un singur fișier de configurare - onedocs.config.ts conține titlul, descrierea, logo-ul, pictograma favicon, linkurile de navigare, subsolul și conținutul paginii principale.
  • Componente MDX - mdxComponents înregistrează casete informative, file, carduri, pași, secțiuni restrângibile, arbori de fișiere, zoom pentru imagini și tabele de tipuri, astfel încât paginile să le poată folosi fără importuri.
  • Presetare CSS - un singur import aduce Tailwind CSS v4, tema Fumadocs UI și stilurile de layout Onedocs.
  • Funcții ajutătoare SEO - funcții pentru sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadatele paginilor și imaginile Open Graph.

Ce configurați voi

Onedocs nu include Next.js sau Fumadocs. Acestea sunt dependențe peer care trebuie instalate alături de acesta:

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

Aveți nevoie și de Tailwind CSS v4, Node.js 20.9 sau o versiune ulterioară și de aproximativ zece fișiere mici: configurația Next.js și Fumadocs MDX, o sursă de conținut, layoutul rădăcină, layoutul documentației și ruta paginilor de documentație. Introducere le prezintă pe toate.

Unde se configurează fiecare lucru

Ce Unde
Titlul site-ului, sigla, navigarea, subsolul onedocs.config.ts, consultați Configurare
Pagina principală, secțiunea principală și funcționalitățile homepage în onedocs.config.ts, randate de HomePage în src/app/page.tsx
Structura și paginile documentației src/app/docs/layout.tsx și src/app/docs/[[...slug]]/page.tsx, consultați Noțiuni introductive
Dosarul de conținut și ordinea barei laterale source.config.ts și content/docs/meta.json
Componentele MDX mdxComponents, consultați Componente
Căutare, hartă a site-ului, robots.txt, llms.txt Fișierele rutelor din src/app/, consultați SEO și căutare
Metadate și imagini Open Graph onedocs/metadata și onedocs/og, consultați ReferințăAPI

Principii

  • Markdown-first - Scrieți .md sau .mdx și obțineți documentația
  • Un singur fișier de configurare - Setările întregului site se află în onedocs.config.ts
  • Opțiuni de extindere - Aveți nevoie de mai mult control? Folosiți direct Fumadocs

Începeți de aici