Preskočiť na obsah

Úvod

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na 7b38e05

Onedocs je súbor rozložení, komponentov a pomocných funkcií pre weby s dokumentáciou vytvorené pomocou Next.js a Fumadocs. Píšete v Markdown, opíšete web v jednom konfiguračnom súbore a Onedocs dodá základ dokumentácie, domovskú stránku a trasy SEO.

Je určený pre samostatné weby s dokumentáciou, nie na pridávanie dokumentácie do existujúcej aplikácie.

Čo pridáva Onedocs

Okrem Fumadocs vám balík onedocs poskytuje:

  • Rozloženia – DocsLayout a DocsPage tvoria základ rozloženia dokumentácie Fumadocs UI s bočným panelom, vyhľadávaním, prepínačom motívu a obsahom. HomePage vykresľuje úvodnú stránku s hlavnou sekciou, príkazmi na inštaláciu, funkciami a pätou.
  • Jeden konfiguračný súbor – onedocs.config.ts obsahuje názov, opis, logo, favicon, navigačné odkazy, pätu a obsah domovskej stránky.
  • Komponenty MDX – mdxComponents registruje upozornenia, záložky, karty, kroky, rozbaľovacie panely, stromové zobrazenia súborov, približovanie obrázkov a tabuľky typov, takže ich stránky môžu používať bez importov.
  • Predvoľba CSS – jedným importom sa načítajú Tailwind CSS v4, motív Fumadocs UI a štýly rozloženia Onedocs.
  • Pomocné funkcie SEO – funkcie pre sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadáta stránok a obrázky Open Graph.

Čo si nastavíte sami

Onedocs nepribaluje Next.js ani Fumadocs. Sú to závislosti, ktoré nainštalujete samostatne:

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

Potrebujete aj Tailwind CSS v4, Node.js 20.9 alebo novší a približne desať malých súborov: Next.js a konfiguračný súbor Fumadocs MDX, zdroj obsahu, koreňové rozloženie, rozloženie dokumentácie a trasu stránky dokumentácie. V príručke Začíname nájdete opis každého z nich.

Kde sa čo nastavuje

Čo Kde
Názov webu, logo, navigácia, päta onedocs.config.ts, pozrite si Konfigurácia
Hlavná sekcia a funkcie domovskej stránky homepage v onedocs.config.ts, vykresľuje ich HomePage v src/app/page.tsx
Rozloženie a stránky dokumentácie src/app/docs/layout.tsx a src/app/docs/[[...slug]]/page.tsx, pozrite si príručku Začíname
Priečinok s obsahom a poradie v bočnom paneli source.config.ts a content/docs/meta.json
Komponenty MDX mdxComponents, pozrite si Komponenty
Vyhľadávanie, mapa webu, robots.txt, llms.txt Súbory trás v src/app/, pozrite si SEO a vyhľadávanie
Metadáta a obrázky Open Graph onedocs/metadata a onedocs/og, pozrite si referenciu API

Filozofia

  • Markdown-first – píšte v .md alebo .mdx a získajte dokumentáciu
  • Jeden konfiguračný súbor – nastavenia celého webu sú v onedocs.config.ts
  • Možnosti rozšírenia – potrebujete väčšiu kontrolu? Použite priamo Fumadocs

Začnite tu