Přejít k obsahu

Úvod

Zobrazit jako Markdown Upravit na GitHub Dokumentace na 7b38e05

Onedocs je sada rozvržení, komponent a pomocných funkcí pro weby s dokumentací vytvořené pomocí Next.js a Fumadocs. Píšete Markdown, popíšete svůj web v jednom konfiguračním souboru a Onedocs dodá prostředí dokumentace, domovskou stránku a trasy SEO.

Je určena pro samostatné weby s dokumentací, nikoli pro přidávání dokumentace do existující aplikace.

Co přidává Onedocs

Kromě Fumadocs vám balíček onedocs poskytuje:

  • Rozvržení – DocsLayout a DocsPage obalují rozvržení dokumentace Fumadocs UI, které obsahuje postranní panel, vyhledávání, přepínač motivu a obsah. HomePage vykresluje úvodní stránku s úvodní sekcí, instalačními příkazy, funkcemi a zápatím.
  • Jeden konfigurační soubor – onedocs.config.ts obsahuje název, popis, logo, favicon, navigační odkazy, zápatí a obsah domovské stránky.
  • Komponenty MDX – mdxComponents registruje upozornění, karty, kroky, akordeony, stromové struktury souborů, přiblížení obrázků a tabulky typů, takže je stránky mohou používat bez importů.
  • Předvolba CSS – jediný import přidá Tailwind CSS v4, motiv Fumadocs UI a styly rozvržení Onedocs.
  • Pomocné funkce SEO – funkce pro sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadata stránek a obrázky Open Graph.

Co nastavujete sami

Onedocs nepřibaluje Next.js ani Fumadocs. Jsou to závislosti peer, které je třeba nainstalovat vedle něj:

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

Potřebujete také Tailwind CSS v4, Node.js 20.9 nebo novější a přibližně deset menších souborů: konfiguraci Next.js a Fumadocs MDX, zdroj obsahu, kořenové rozvržení, rozvržení dokumentace a trasu stránky dokumentace. V části Začínáme najdete popis každého z nich.

Kde se co konfiguruje

Co Kde
Název webu, logo, navigace, zápatí onedocs.config.ts, viz Konfigurace
Úvodní sekce a funkce domovské stránky homepage v onedocs.config.ts, vykresluje je HomePage v src/app/page.tsx
Rozvržení a stránky dokumentace src/app/docs/layout.tsx a src/app/docs/[[...slug]]/page.tsx, viz Začínáme
Složka s obsahem a pořadí postranního panelu source.config.ts a content/docs/meta.json
Komponenty MDX mdxComponents, viz Komponenty
Vyhledávání, mapa webu, robots.txt, llms.txt Soubory tras v src/app/, viz SEO a vyhledávání
Metadata a obrázky Open Graph onedocs/metadata a onedocs/og, viz referenční příručka API

Filozofie

  • Nejdřív Markdown – Pište .md nebo .mdx a získejte dokumentaci
  • Jeden konfigurační soubor – Nastavení celého webu je v onedocs.config.ts
  • Možnost rozšíření – Potřebujete větší kontrolu? Použijte přímo Fumadocs

Začněte zde