# Sissejuhatus

Onedocs on paigutuste, komponentide ja abifunktsioonide komplekt dokumentatsioonisaitidele, mis on loodud Next.js ja Fumadocs abil. Kirjutad Markdown, kirjeldad oma saiti ühes konfiguratsioonifailis ning Onedocs pakub dokumentatsiooni kesta, avalehte ja SEO marsruute.

See on mõeldud eraldiseisvatele dokumentatsioonisaitidele, mitte dokumentatsiooni lisamiseks olemasolevale rakendusele.

## Mida Onedocs pakub

Lisaks Fumadocs-ile annab pakett `onedocs` sulle:

- **Paigutused** – `DocsLayout` ja `DocsPage` ümbritsevad Fumadocs UI dokumentatsioonipaigutust, kus on külgriba, otsing, kujunduse lüliti ja sisukord. `HomePage` renderdab maandumislehe avavaate, paigalduskäskude, funktsioonide ja jalusega.
- **Üks konfiguratsioonifail** – `onedocs.config.ts` sisaldab pealkirja, kirjeldust, logo, lemmikut, navigeerimislinke, jalust ja avalehe sisu.
- **MDX komponendid** – `mdxComponents` registreerib teavitused, vahekaardid, kaardid, sammud, akordionid, failipuud, pildi suurenduse ja tüübiteabe tabelid, et saaksid neid lehtedel ilma importimata kasutada.
- **CSS eelseadistus** – üks import lisab Tailwind CSS v4, kujunduse Fumadocs UI ja Onedocs paigutusstiilid.
- **SEO abifunktsioonid** – funktsioonid `sitemap.xml`, `robots.txt`, `llms.txt`, `llms-full.txt`, lehe metaandmete ja Open Graph piltide jaoks.

## Mida seadistad ise

Onedocs ei sisalda komplektis Next.js ega Fumadocs. Need on partner-sõltuvused, mis tuleb selle kõrvale paigaldada:

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

Vaja läheb ka Tailwind CSS v4-i, versiooni Node.js 20.9 või uuemat ning umbes kümmet väikest faili: Next.js ja Fumadocs MDX konfiguratsioon, sisuallikas, juurpaigutus, dokumentatsiooni paigutus ja dokumentatsioonilehe marsruut. [Alustamine](https://onedocs.inline0.dev/et/docs/getting-started) näitab neid kõiki.

## Kus seadeid määrata

| Mida | Kus |
|------|-------|
| Saidi pealkiri, logo, navigeerimine, jalus | `onedocs.config.ts`, vt [Konfigureerimine](https://onedocs.inline0.dev/et/docs/configuration) |
| Avalehe avavaade ja funktsioonid | `onedocs.config.ts` jaotises `homepage`, renderdab `HomePage` jaotises `src/app/page.tsx` |
| Dokumentatsiooni paigutus ja lehed | `src/app/docs/layout.tsx` ja `src/app/docs/[[...slug]]/page.tsx`, vt [Alustamine](https://onedocs.inline0.dev/et/docs/getting-started) |
| Sisukaust ja külgriba järjekord | `source.config.ts` ja `content/docs/meta.json` |
| MDX komponendid | `mdxComponents`, vt [Komponendid](https://onedocs.inline0.dev/et/docs/components) |
| Otsing, saidikaart, robots.txt, llms.txt | Marsruudifailid asukohas `src/app/`, vt [SEO ja otsing](https://onedocs.inline0.dev/et/docs/seo-search) |
| Metaandmed ja Open Graph pildid | `onedocs/metadata` ja `onedocs/og`, vt [API viide](https://onedocs.inline0.dev/et/docs/api-reference) |

## Põhimõtted

- **Markdown-esmalt** – kirjuta `.md` või `.mdx` ja saad dokumentatsiooni
- **Üks konfiguratsioonifail** – kogu saidi seaded asuvad failis `onedocs.config.ts`
- **Vabad käed** – vajad rohkem kontrolli? Kasuta otse Fumadocs

## Alusta siit

- [Alustamine](https://onedocs.inline0.dev/et/docs/getting-started)
- [Komponendid](https://onedocs.inline0.dev/et/docs/components)
- [SEO ja otsing](https://onedocs.inline0.dev/et/docs/seo-search)
- [Konfigureerimine](https://onedocs.inline0.dev/et/docs/configuration)
- [API viide](https://onedocs.inline0.dev/et/docs/api-reference)