Към съдържанието

Въведение

Преглед като Markdown Редактиране в GitHub Документация за 7b38e05

Onedocs е набор от оформления, компоненти и помощни функции за сайтове за документация, създадени с Next.js и Fumadocs. Пишете Markdown, описвате сайта си в един конфигурационен файл, а Onedocs предоставя основата за документацията, начална страница и маршрутите SEO.

Предназначен е за самостоятелни сайтове за документация, а не за добавяне на документация към съществуващо приложение.

Какво добавя Onedocs

В допълнение към Fumadocs пакетът onedocs ви предоставя:

  • Оформления — DocsLayout и DocsPage обгръщат оформлението за документация Fumadocs UI със странична лента, търсене, превключвател на темата и съдържание. HomePage визуализира начална страница с основна секция, команди за инсталиране, функции и футър.
  • Един конфигурационен файл — onedocs.config.ts съдържа заглавието, описанието, логото, иконата на сайта, навигационните връзки, футъра и съдържанието на началната страница.
  • Компоненти MDX — mdxComponents регистрира карета с важна информация, раздели, карти, стъпки, разгъващи се панели, дървета на файлове, увеличаване на изображения и таблици с типове, така че страниците да ги използват без импортиране.
  • Предварителна настройка CSS — с един импорт получавате Tailwind CSS v4, темата Fumadocs UI и стиловете на оформлението Onedocs.
  • Помощни функции SEO — функции за sitemap.xml, robots.txt, llms.txt, llms-full.txt, метаданни на страниците и изображения Open Graph.

Какво настройвате сами

Onedocs не включва Next.js или Fumadocs. Те са peer зависимости, които инсталирате заедно с него:

Обвивка
npm install onedocs fumadocs-core fumadocs-mdx fumadocs-ui lucide-react@0.562 next react react-dom

Нужни са ви също Tailwind CSS v4, Node.js 20.9 или по-нова версия и около десет малки файла: конфигурациите Next.js и Fumadocs MDX, източник на съдържание, кореново оформление, оформление на документацията и маршрут на страницата с документацията. В „Първи стъпки“ са показани всички.

Къде се конфигурират елементите

Какво Къде
Заглавие на сайта, лого, навигация, футър onedocs.config.ts, вижте Конфигурация
Основна секция и функции на началната страница homepage в onedocs.config.ts, визуализирани от HomePage в src/app/page.tsx
Оформление и страници на документацията src/app/docs/layout.tsx и src/app/docs/[[...slug]]/page.tsx, вижте „Първи стъпки“
Папка със съдържание и ред в страничната лента source.config.ts и content/docs/meta.json
Компоненти MDX mdxComponents, вижте Компоненти
Търсене, карта на сайта, robots.txt, llms.txt Файлове с маршрути в src/app/, вижте SEO и търсене
Метаданни и изображения Open Graph onedocs/metadata и onedocs/og, вижте справочника за API

Философия

  • Първо Markdown — пишете .md или .mdx и получавате документация
  • Един конфигурационен файл — настройките за целия сайт са в onedocs.config.ts
  • Възможности за разширяване — трябва ви повече контрол? Използвайте директно Fumadocs

Започнете оттук