Ugrás a tartalomhoz

Bevezetés

Megtekintés Markdownként Szerkesztés itt: GitHub Dokumentáció itt: 7b38e05

A Onedocs elrendezések, összetevők és segédfüggvények készlete a Next.js és a Fumadocs használatával készült dokumentációs webhelyekhez. Ön Markdown fájlokat ír, egy konfigurációs fájlban írja le a webhelyet, a Onedocs pedig biztosítja a dokumentációs keretet, a kezdőlapot és a SEO útvonalakat.

Önálló dokumentációs webhelyekhez készült, nem meglévő alkalmazások dokumentációval való kiegészítésére.

Mit nyújt a Onedocs

A Fumadocs mellett a onedocs csomag a következőket kínálja:

  • Elrendezések – a DocsLayout és a DocsPage az Fumadocs UI dokumentációs elrendezését veszik körül oldalsávval, kereséssel, témaváltóval és tartalomjegyzékkel. A HomePage nyitóoldalt jelenít meg kiemelt résszel, telepítési parancsokkal, funkciókkal és lábléccel.
  • Egyetlen konfigurációs fájl – a onedocs.config.ts tartalmazza a címet, a leírást, a logót, a favicon-t, a navigációs hivatkozásokat, a láblécet és a kezdőlap tartalmát.
  • MDX összetevők – a mdxComponents regisztrálja a kiemelődobozokat, a lapfüleket, a kártyákat, a lépéseket, a harmonikaelemeket, a fájlstruktúrákat, a nagyítható képeket és a típustáblázatokat, így az oldalakon importálás nélkül használhatók.
  • CSS előbeállítás – egyetlen import betölti a Tailwind CSS v4, az Fumadocs UI témát és az Onedocs elrendezésstílusait.
  • SEO segédfüggvények – függvények a sitemap.xml, robots.txt, llms.txt, llms-full.txt, az oldalmetaadatok és a Open Graph képek kezelésére.

Amit Önnek kell beállítania

A Onedocs nem tartalmazza a Next.js és a Fumadocs csomagot. Ezek társfüggőségek, amelyeket mellette kell telepítenie:

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

Szüksége lesz továbbá a Tailwind CSS v4 csomagra, a Node.js 20.9-es vagy újabb verziójára, valamint körülbelül tíz kisebb fájlra: az Next.js és Fumadocs MDX konfigurációra, egy tartalomforrásra, a gyökérelrendezésre, a dokumentáció elrendezésére és a dokumentációs útvonalra. A Kezdő lépések mindegyiket bemutatja.

Hol kell beállítani az elemeket

Mi Hol
Webhely címe, logója, navigációja, lábléce onedocs.config.ts, lásd a Konfiguráció részt
A kezdőlap kiemelt része és funkciói homepage a onedocs.config.ts fájlban; megjeleníti a HomePage a src/app/page.tsx fájlban
Dokumentációs elrendezés és oldalak src/app/docs/layout.tsx és src/app/docs/[[...slug]]/page.tsx, lásd a Kezdő lépések részt
Tartalommappa és oldalsáv sorrendje source.config.ts és content/docs/meta.json
MDX összetevők mdxComponents, lásd az Összetevők részt
Keresés, webhelytérkép, robots.txt, llms.txt Útvonalfájlok a src/app/ alatt, lásd a SEO és keresés útmutatót
Metaadatok és Open Graph képek onedocs/metadata és onedocs/og, lásd az API dokumentációs referenciát

Alapelvek

  • Markdown-központú – Írjon .md vagy .mdx fájlokat, és máris kész a dokumentáció
  • Egyetlen konfigurációs fájl – A webhelyszintű beállítások a onedocs.config.ts fájlban találhatók
  • Kibúvók – Több vezérlésre van szüksége? Használja közvetlenül a Fumadocs csomagot

Kezdje itt