Pāriet uz saturu

Ievads

Skatīt kā Markdown Rediģēt vietnē GitHub Dokumentācija vietnē 7b38e05

Onedocs ir izkārtojumu, komponentu un palīgfunkciju kopums dokumentācijas vietnēm, kas veidotas ar Next.js un Fumadocs. Jūs rakstāt Markdown, aprakstāt vietni vienā konfigurācijas failā, un Onedocs nodrošina dokumentācijas ietvaru, sākumlapu un SEO maršrutus.

Tas paredzēts atsevišķām dokumentācijas vietnēm, nevis dokumentācijas pievienošanai esošai lietotnei.

Ko pievieno Onedocs

Papildus Fumadocs pakotne onedocs nodrošina:

  • Izkārtojumi — DocsLayout un DocsPage ietver Fumadocs UI dokumentācijas izkārtojumu ar sānjoslu, meklēšanu, tēmas pārslēgu un satura rādītāju. HomePage renderē galveno lapu ar galveno bloku, instalēšanas komandām, iespējām un kājeni.
  • Viens konfigurācijas fails — onedocs.config.ts glabā nosaukumu, aprakstu, logotipu, vietnes ikonu, navigācijas saites, kājeni un sākumlapas saturu.
  • MDX komponenti — mdxComponents reģistrē piezīmes, cilnes, kartītes, darbību sarakstus, akordeonus, failu kokus, attēlu pietuvināšanu un tipu tabulas, lai lapās tos varētu izmantot bez importēšanas.
  • CSS sākotnējā konfigurācija — viens imports ielādē Tailwind CSS v4, tēmu Fumadocs UI un izkārtojuma Onedocs stilus.
  • SEO palīgfunkcijas — funkcijas priekš sitemap.xml, robots.txt, llms.txt, llms-full.txt, lapas metadatiem un Open Graph attēliem.

Kas jāiestata pašam

Onedocs neietver Next.js vai Fumadocs. Tās ir vienādranga atkarības, kas jāinstalē atsevišķi:

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

Jums nepieciešams arī Tailwind CSS v4, Node.js 20.9 vai jaunāka versija un aptuveni desmit nelieli faili: Next.js un Fumadocs MDX konfigurācija, satura avots, saknes izkārtojums, dokumentācijas izkārtojums un dokumentācijas lapas maršruts. Sadaļā Darba sākšana ir aprakstīts katrs fails.

Kur tiek konfigurēti iestatījumi

Kas Kur
Vietnes nosaukums, logotips, navigācija, kājene onedocs.config.ts, skatiet Konfigurācija
Sākumlapas galvenais bloks un iespējas homepage failā onedocs.config.ts, renderē HomePage failā src/app/page.tsx
Dokumentācijas izkārtojums un lapas src/app/docs/layout.tsx un src/app/docs/[[...slug]]/page.tsx, skatiet Darba sākšana
Satura mape un sānjoslas secība source.config.ts un content/docs/meta.json
MDX komponenti mdxComponents, skatiet Komponenti
Meklēšana, vietnes karte, robots.txt, llms.txt Maršrutu faili mapē src/app/, skatiet SEO un meklēšana
Metadati un Open Graph attēli onedocs/metadata un onedocs/og, skatiet API uzziņu materiālā

Filosofija

  • Markdown vispirms — rakstiet .md vai .mdx, saņemiet dokumentāciju
  • Viens konfigurācijas fails — visas vietnes iestatījumi atrodas failā onedocs.config.ts
  • Papildu iespējas — vajag vairāk kontroles? Izmantojiet tieši Fumadocs

Sāciet šeit