# Įvadas

Onedocs – tai maketų, komponentų ir pagalbinių funkcijų rinkinys dokumentacijos svetainėms, sukurtoms naudojant Next.js ir Fumadocs. Rašote Markdown, aprašote svetainę viename konfigūracijos faile, o Onedocs pateikia dokumentacijos apvalkalą, pradinį puslapį ir SEO maršrutus.

Jis skirtas atskiroms dokumentacijos svetainėms, o ne dokumentacijai pridėti prie esamos programos.

## Ką suteikia Onedocs

Be Fumadocs, paketas `onedocs` suteikia:

- **Maketai** – `DocsLayout` ir `DocsPage` apgaubia Fumadocs UI dokumentacijos maketą su šonine juosta, paieška, temos perjungikliu ir turiniu. `HomePage` pateikia nukreipimo puslapį su pagrindine antrašte, diegimo komandomis, funkcijomis ir porašte.
- **Vienas konfigūracijos failas** – `onedocs.config.ts` saugomi pavadinimas, aprašymas, logotipas, favicon, naršymo nuorodos, poraštė ir pradinio puslapio turinys.
- **MDX komponentai** – `mdxComponents` registruoja pranešimų blokus, skirtukus, korteles, veiksmų sekas, išskleidžiamas skiltis, failų medžius, vaizdų mastelio keitimą ir tipų lenteles, todėl puslapiuose juos galima naudoti be importų.
- **CSS išankstinis nustatymas** – vienas importas įtraukia Tailwind CSS v4, Fumadocs UI temą ir Onedocs maketo stilius.
- **SEO pagalbinės funkcijos** – funkcijos, skirtos `sitemap.xml`, `robots.txt`, `llms.txt`, `llms-full.txt`, puslapio metaduomenims ir Open Graph vaizdams.

## Ką reikia nustatyti patiems

Onedocs neapima Next.js ar Fumadocs. Tai priklausomybės, kurias įdiegiate greta jo:

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

Taip pat reikia Tailwind CSS v4, Node.js 20.9 ar naujesnės versijos ir maždaug dešimties nedidelių failų: Next.js ir Fumadocs MDX konfigūracijos, turinio šaltinio, šakninio maketo, dokumentacijos maketo ir dokumentacijos puslapio maršruto. [Darbo pradžia](https://onedocs.inline0.dev/lt/docs/getting-started) aprašo kiekvieną iš jų.

## Kur kas konfigūruojama

| Kas | Kur |
|------|-------|
| Svetainės pavadinimas, logotipas, naršymas, poraštė | `onedocs.config.ts`, žr. [Konfigūracija](https://onedocs.inline0.dev/lt/docs/configuration) |
| Pradinio puslapio pagrindinė antraštė ir funkcijos | `homepage` faile `onedocs.config.ts`, atvaizduoja `HomePage` faile `src/app/page.tsx` |
| Dokumentacijos maketas ir puslapiai | `src/app/docs/layout.tsx` ir `src/app/docs/[[...slug]]/page.tsx`, žr. [Darbo pradžia](https://onedocs.inline0.dev/lt/docs/getting-started) |
| Turinio aplankas ir šoninės juostos tvarka | `source.config.ts` ir `content/docs/meta.json` |
| MDX komponentai | `mdxComponents`, žr. [Komponentai](https://onedocs.inline0.dev/lt/docs/components) |
| Paieška, svetainės schema, robots.txt, llms.txt | Maršrutų failai aplanke `src/app/`, žr. [SEO ir paieška](https://onedocs.inline0.dev/lt/docs/seo-search) |
| Metaduomenys ir Open Graph vaizdai | `onedocs/metadata` ir `onedocs/og`, žr. [API nuoroda](https://onedocs.inline0.dev/lt/docs/api-reference) |

## Pagrindinės idėjos

- **Markdown pirmiausia** – rašykite `.md` arba `.mdx` ir gaukite dokumentaciją
- **Vienas konfigūracijos failas** – visos svetainės nustatymai saugomi faile `onedocs.config.ts`
- **Daugiau kontrolės** – reikia daugiau kontrolės? Naudokite tiesiogiai Fumadocs

## Pradėkite čia

- [Darbo pradžia](https://onedocs.inline0.dev/lt/docs/getting-started)
- [Komponentai](https://onedocs.inline0.dev/lt/docs/components)
- [SEO ir paieška](https://onedocs.inline0.dev/lt/docs/seo-search)
- [Konfigūracija](https://onedocs.inline0.dev/lt/docs/configuration)
- [API nuoroda](https://onedocs.inline0.dev/lt/docs/api-reference)