Liigu sisu juurde

Sissejuhatus

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: 7b38e05

Onedocs on paigutuste, komponentide ja abifunktsioonide komplekt dokumentatsioonisaitidele, mis on loodud Next.js ja Fumadocs abil. Kirjutad Markdown, kirjeldad oma saiti ühes konfiguratsioonifailis ning Onedocs pakub dokumentatsiooni kesta, avalehte ja SEO marsruute.

See on mõeldud eraldiseisvatele dokumentatsioonisaitidele, mitte dokumentatsiooni lisamiseks olemasolevale rakendusele.

Mida Onedocs pakub

Lisaks Fumadocs-ile annab pakett onedocs sulle:

  • Paigutused – DocsLayout ja DocsPage ümbritsevad Fumadocs UI dokumentatsioonipaigutust, kus on külgriba, otsing, kujunduse lüliti ja sisukord. HomePage renderdab maandumislehe avavaate, paigalduskäskude, funktsioonide ja jalusega.
  • Üks konfiguratsioonifail – onedocs.config.ts sisaldab pealkirja, kirjeldust, logo, lemmikut, navigeerimislinke, jalust ja avalehe sisu.
  • MDX komponendid – mdxComponents registreerib teavitused, vahekaardid, kaardid, sammud, akordionid, failipuud, pildi suurenduse ja tüübiteabe tabelid, et saaksid neid lehtedel ilma importimata kasutada.
  • CSS eelseadistus – üks import lisab Tailwind CSS v4, kujunduse Fumadocs UI ja Onedocs paigutusstiilid.
  • SEO abifunktsioonid – funktsioonid sitemap.xml, robots.txt, llms.txt, llms-full.txt, lehe metaandmete ja Open Graph piltide jaoks.

Mida seadistad ise

Onedocs ei sisalda komplektis Next.js ega Fumadocs. Need on partner-sõltuvused, mis tuleb selle kõrvale paigaldada:

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

Vaja läheb ka Tailwind CSS v4-i, versiooni Node.js 20.9 või uuemat ning umbes kümmet väikest faili: Next.js ja Fumadocs MDX konfiguratsioon, sisuallikas, juurpaigutus, dokumentatsiooni paigutus ja dokumentatsioonilehe marsruut. Alustamine näitab neid kõiki.

Kus seadeid määrata

Mida Kus
Saidi pealkiri, logo, navigeerimine, jalus onedocs.config.ts, vt Konfigureerimine
Avalehe avavaade ja funktsioonid onedocs.config.ts jaotises homepage, renderdab HomePage jaotises src/app/page.tsx
Dokumentatsiooni paigutus ja lehed src/app/docs/layout.tsx ja src/app/docs/[[...slug]]/page.tsx, vt Alustamine
Sisukaust ja külgriba järjekord source.config.ts ja content/docs/meta.json
MDX komponendid mdxComponents, vt Komponendid
Otsing, saidikaart, robots.txt, llms.txt Marsruudifailid asukohas src/app/, vt SEO ja otsing
Metaandmed ja Open Graph pildid onedocs/metadata ja onedocs/og, vt API viide

Põhimõtted

  • Markdown-esmalt – kirjuta .md või .mdx ja saad dokumentatsiooni
  • Üks konfiguratsioonifail – kogu saidi seaded asuvad failis onedocs.config.ts
  • Vabad käed – vajad rohkem kontrolli? Kasuta otse Fumadocs

Alusta siit