Przejdź do treści

Wprowadzenie

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 7b38e05

Onedocs to zestaw układów, komponentów i funkcji pomocniczych dla witryn dokumentacji tworzonych za pomocą Next.js i Fumadocs. Piszesz Markdown, opisujesz witrynę w jednym pliku konfiguracyjnym, a Onedocs udostępnia szkielet dokumentacji, stronę główną i trasy SEO.

Jest przeznaczony dla samodzielnych witryn dokumentacji, a nie do dodawania dokumentacji do istniejącej aplikacji.

Co zapewnia Onedocs

Oprócz Fumadocs pakiet onedocs zapewnia:

  • Układy - DocsLayout i DocsPage opakowują układ dokumentacji Fumadocs UI, który zawiera pasek boczny, wyszukiwanie, przełącznik motywu i spis treści. HomePage renderuje stronę docelową z sekcją główną, poleceniami instalacji, funkcjami i stopką.
  • Jeden plik konfiguracyjny - onedocs.config.ts zawiera tytuł, opis, logo, ikonę favicon, linki nawigacyjne, stopkę i treść strony głównej.
  • Komponenty MDX - mdxComponents rejestruje komunikaty, karty, układy kart, kroki, akordeony, drzewa plików, powiększanie obrazów i tabele typów, dzięki czemu strony mogą z nich korzystać bez importowania.
  • Ustawienie wstępne CSS - jeden import dodaje Tailwind CSS v4, motyw Fumadocs UI i style układu Onedocs.
  • Funkcje pomocnicze SEO - funkcje do sitemap.xml, robots.txt, llms.txt, llms-full.txt, metadanych stron i obrazów Open Graph.

Co konfigurujesz samodzielnie

Onedocs nie zawiera Next.js ani Fumadocs. Są to zależności partnerskie, które instalujesz obok niego:

Powłoka
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

Potrzebujesz też Tailwind CSS v4, Node.js w wersji 20.9 lub nowszej oraz około dziesięciu niewielkich plików: konfiguracji Next.js i Fumadocs MDX, źródła treści, głównego układu, układu dokumentacji oraz trasy strony dokumentacji. W sekcji Pierwsze kroki opisano każdy z nich.

Gdzie konfiguruje się poszczególne elementy

Co Gdzie
Tytuł witryny, logo, nawigacja, stopka onedocs.config.ts, zobacz Konfiguracja
Sekcja główna i funkcje strony głównej homepage w onedocs.config.ts, renderowane przez HomePage w src/app/page.tsx
Układ i strony dokumentacji src/app/docs/layout.tsx i src/app/docs/[[...slug]]/page.tsx, zobacz Pierwsze kroki
Folder z treścią i kolejność na pasku bocznym source.config.ts i content/docs/meta.json
Komponenty MDX mdxComponents, zobacz Komponenty
Wyszukiwanie, mapa witryny, robots.txt, llms.txt Pliki tras w src/app/, zobacz SEO i wyszukiwanie
Metadane i obrazy Open Graph onedocs/metadata i onedocs/og, zobacz API—dokumentację referencyjną

Filozofia

  • Najpierw Markdown - Pisz .md lub .mdx, a otrzymasz dokumentację
  • Jeden plik konfiguracyjny - Ustawienia całej witryny znajdują się w onedocs.config.ts
  • Większa swoboda - Potrzebujesz większej kontroli? Użyj bezpośrednio Fumadocs

Zacznij tutaj