# API Reference

Úplný přehled všech exportů z balíčku `onedocs`.

## Vstupní body

| Import | Popis |
|--------|-------------|
| `onedocs` | Hlavní vstup – rozvržení, komponenty, `mdxComponents`, `defineConfig`, pomocné funkce pro zdroje |
| `onedocs/components` | Komponenty Fumadocs UI a také `InstallBlock`, `CodeBlock`, `Button` a `Logo` |
| `onedocs/config` | Pomocné funkce konfigurace |
| `onedocs/source` | Nástroje pro zdroje obsahu |
| `onedocs/metadata` | Generování metadat |
| `onedocs/og` | Generování obrázků OpenGraph |
| `onedocs/llms` | Generování LLMs.txt |
| `onedocs/seo` | Mapa webu a robots.txt |
| `onedocs/css/preset.css` | Přednastavení Tailwind CSS |

## Rozvržení

### DocsLayout

Hlavní obalové rozvržení stránek dokumentace. Poskytuje navigaci v postranním panelu, vyhledávání a přepínač motivu.

```tsx
import { DocsLayout } from "onedocs";

export default function Layout({ children }: { children: React.ReactNode }) {
  return (
    <DocsLayout config={config} pageTree={source.pageTree}>
      {children}
    </DocsLayout>
  );
}
```

**Vlastnosti:**
- `config` – váš objekt `OnedocsConfig`
- `pageTree` – strom stránek ze zdroje (např. e.g, `source.pageTree`)
- `children` – obsah stránky

### DocsPage

Obal pro jednotlivé stránky dokumentace. Obaluje Fumadocs UI `DocsPage` a umístí obsah do `DocsBody`.

```tsx
import { DocsPage, mdxComponents } from "onedocs";
import { notFound } from "next/navigation";

export default async function Page(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();
  const MDX = page.data.body;

  return (
    <DocsPage toc={page.data.toc}>
      <MDX components={mdxComponents} />
    </DocsPage>
  );
}
```

**Vlastnosti:**
- `toc` – obsah z dat stránky
- `children` – obsah MDX
- Jakákoli další vlastnost Fumadocs UI `DocsPage`, například `full`

### DocsBody

Vnitřní obal obsahu dokumentace. Interně jej používá `DocsPage`.

```tsx
import { DocsBody } from "onedocs";

<DocsBody>
  <MDX components={mdxComponents} />
</DocsBody>
```

### HomePage

Kompletní komponenta úvodní stránky s hlavní sekcí, funkcemi a patičkou.

```tsx
import { HomePage, CTASection } from "onedocs";

export default function Home() {
  return (
    <HomePage config={config} packageName="my-package">
      <CTASection
        title="Ready to get started?"
        cta={{ label: "Read the Docs", href: "/docs" }}
      />
    </HomePage>
  );
}
```

**Vlastnosti:**
- `config` – váš objekt `OnedocsConfig`
- `packageName` – název balíčku pro instalační blok (volitelné)
- `children` – obsah mezi funkcemi a patičkou (volitelné)

Informace o tom, co konfigurace ovládá, najdete v části [úvodní stránka](https://onedocs.inline0.dev/cs/docs/configuration#homepage) a [patička](https://onedocs.inline0.dev/cs/docs/configuration#footer).

### HomeLayout

Základní rozvržení úvodní stránky (interně jej používá `HomePage`).

```tsx
import { HomeLayout } from "onedocs";

<HomeLayout config={config}>
  {/* Custom homepage content */}
</HomeLayout>
```

### createBaseOptions

Z konfigurace vytváří možnosti rozvržení Fumadocs UI (název nebo logo navigační lišty, `nav.links` a odkaz GitHub). Používají jej `DocsLayout` a `HomeLayout`; zavolejte jej sami, pokud přímo vykreslujete rozvržení Fumadocs UI.

```tsx
import { DocsLayout } from "fumadocs-ui/layouts/docs";
import { createBaseOptions } from "onedocs";

<DocsLayout {...createBaseOptions(config)} tree={source.pageTree}>
  {children}
</DocsLayout>
```

## Komponenty

### InstallBlock

Karty správců balíčků zobrazující instalační příkazy pro npm, yarn, pnpm a bun (`npm i`, `yarn add`, `pnpm add`, `bun add`). Jde o asynchronní komponentu serveru.

```tsx
import { InstallBlock } from "onedocs";

<InstallBlock packageName="onedocs" />
```

**Vlastnosti:**
- `packageName` – název balíčku npm, který se má nainstalovat
- `title` – nadpis nad kartami (volitelné)
- `description` – text nad kartami (volitelné)
- `children` – obsah pod kartami (volitelné)

### Button

Zaoblený odkaz stylovaný jako primární tlačítko. Má jeden styl.

```tsx
import { Button } from "onedocs";

<Button href="/docs">Get Started</Button>
```

**Vlastnosti:**
- `href` – cíl odkazu
- `children` – text tlačítka
- `className` – další třídy (volitelné)

### Logo

Vykreslí světlý i tmavý obrázek a zobrazí ten, který odpovídá aktuálnímu motivu. `DocsLayout` a `HomePage` jej používají pro `logo` se světlou a tmavou variantou.

```tsx
import { Logo } from "onedocs";

<Logo light="/logo-light.svg" dark="/logo-dark.svg" alt="My Project" className="h-6" />
```

**Vlastnosti:**
- `light` – cesta k obrázku pro světlý režim
- `dark` – cesta k obrázku pro tmavý režim
- `alt` – alternativní text (výchozí: `"Logo"`)
- `className` – třídy pro oba obrázky (volitelné)

### CTASection

Sekce s výzvou k akci na úvodní stránce.

```tsx
import { CTASection } from "onedocs";

<CTASection
  title="Ready to get started?"
  description="Optional description text"
  cta={{ label: "Get Started", href: "/docs" }}
/>
```

**Vlastnosti:**
- `title` – nadpis sekce
- `description` – text pod nadpisem (volitelné)
- `cta` – konfigurace tlačítka s `label` a `href`
- `children` – obsah pod tlačítkem (volitelné)

### FontHead

Přednačte proměnné písmo Inter, deklaruje jeho `@font-face` a nastaví je jako písmo stránky. Přidejte jej do `<head>` kořenového rozvržení.

```tsx
import { FontHead } from "onedocs";

<html>
  <head>
    <FontHead />
  </head>
  <body>{children}</body>
</html>
```

Onedocs písmo nedodává. Ve výchozím nastavení `FontHead` načítá `/fonts/InterVariable.woff2`, proto soubor umístěte do `public/fonts/` nebo předejte jiné URL pomocí `fontPath`:

```tsx
<FontHead fontPath="/assets/Inter.woff2" />
```

### GitHubIcon

Komponenta ikony GitHub (interně používaná v navigaci).

```tsx
import { GitHubIcon } from "onedocs";

<GitHubIcon className="size-5" />
```

### CodeBlock

Blok kódu se zvýrazněnou syntaxí, kterou na serveru zajišťuje Shiki prostřednictvím Fumadocs. Jde o asynchronní komponentu serveru.

```tsx
import { CodeBlock } from "onedocs";

<CodeBlock lang="tsx" code="const x = 1;" />
```

## Konfigurace

### defineConfig

Pomocná funkce pro typově bezpečnou konfiguraci.

```tsx
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Docs",
  // ... other options
});
```

### OnedocsConfig

Typ TypeScript pro konfiguraci.

```tsx
import type { OnedocsConfig } from "onedocs/config";

const config: OnedocsConfig = {
  title: "My Docs",
};
```

Všechny možnosti najdete v části [Konfigurace](https://onedocs.inline0.dev/cs/docs/configuration).

## Pomocné funkce pro zdroje

### loader

Znovu exportovaný loader `fumadocs-core/source` pro vytváření zdrojů obsahu.

```tsx
import { loader } from "onedocs/source";

export const source = loader({
  baseUrl: "/docs",
  source: docs.toFumadocsSource(),
});
```

### createSource

Pomocná funkce pro vytváření zdroje obsahu (obal kolem loaderu). Základní URL má výchozí hodnotu `/docs`.

```tsx
import { createSource } from "onedocs/source";
import { docs } from "../../.source/server";

export const source = createSource(docs);
// export const source = createSource(docs, { baseUrl: "/guide" });
```

V 0.1.27 `createSource` vrací netypovaný zdroj, takže TypeScript hlásí při čtení `page.data` chyby, například `Property 'data' does not exist on type 'unknown'` ([#4](https://github.com/inline0/onedocs/issues/4)). Do opravy používejte `loader`, jak je ukázáno výše.

## Metadata

### createMetadata

Generuje metadata Next.js pro kořenové rozvržení.

```tsx
import { createMetadata } from "onedocs/metadata";

export const metadata = createMetadata(config, {
  baseUrl: "https://example.com",
});
```

**Možnosti:**
- `baseUrl` – základní URL vašeho webu (volitelné)
- `additional` – další pole `Metadata` sloučená jako poslední (volitelné)

**Vrací:** objekt Next.js `Metadata` obsahující:
- Název (`config.title`) a šablonu názvu (`%s | Site Name`)
- Popis
- Ikonu webu z `config.icon`, pokud je nastavena
- Pokud je nastavena možnost `baseUrl`: `metadataBase`, metadata OpenGraph a kartu Twitter `summary_large_image`

### createDocsPageMetadata

Generuje metadata názvu a popisu stránky dokumentace. Přijímá jeden objekt s `title` a volitelným `description`.

```tsx
import { createDocsPageMetadata } from "onedocs/metadata";
import { notFound } from "next/navigation";

export async function generateMetadata(props: {
  params: Promise<{ slug?: string[] }>;
}) {
  const params = await props.params;
  const page = source.getPage(params.slug);
  if (!page) notFound();

  return createDocsPageMetadata({
    title: page.data.title,
    description: page.data.description,
  });
}
```

Informace o obrázku Open Graph pro jednotlivé stránky najdete v části [Dynamické obrázky OG](#dynamic-og-images).

## Obrázky OpenGraph

### createRootOGImage

Vytváří obrázek OG pro úvodní stránku: vaše logo uprostřed černého pozadí.

```tsx
// src/app/opengraph-image.tsx
import {
  createRootOGImage,
  loadPublicFile,
  ogImageSize,
  ogImageContentType,
  type OGImageLogo,
} from "onedocs/og";

export const size = ogImageSize;
export const contentType = ogImageContentType;

export default async function Image() {
  const logo = await loadPublicFile("logo-dark.svg");
  return createRootOGImage(logo as OGImageLogo);
}
```

### createDocsOGImage

Vytváří obrázek OG pro stránky dokumentace: logo vlevo nahoře a název bílým písmem na černém pozadí. Argument písma je volitelný; bez něj se název zobrazí systémovým písmem.

```tsx
// src/app/docs/opengraph-image.tsx
import {
  createDocsOGImage,
  loadPublicFile,
  loadInterFont,
  ogImageSize,
  ogImageContentType,
  type OGImageLogo,
} from "onedocs/og";

export const size = ogImageSize;
export const contentType = ogImageContentType;

export default async function Image() {
  const [logo, font] = await Promise.all([
    loadPublicFile("logo-dark.svg"),
    loadInterFont(),
  ]);
  return createDocsOGImage("Documentation", logo as OGImageLogo, font);
}
```

### Dynamické obrázky OG

Obrázky OG pro jednotlivé stránky poskytujte přes routu. Stránky na tuto routu automaticky neodkazují: přidejte ji sami do metadat každé stránky, například pomocí `openGraph: { images: "/docs/og/getting-started" }` vedle polí z `createDocsPageMetadata`.

```tsx
// src/app/docs/og/[...slug]/route.tsx
import {
  createDocsOGImage,
  loadPublicFile,
  loadInterFont,
  type OGImageLogo,
} from "onedocs/og";
import { source } from "@/lib/source";

export async function GET(
  _request: Request,
  { params }: { params: Promise<{ slug: string[] }> }
) {
  const { slug } = await params;
  const page = source.getPage(slug);
  const title = page?.data.title ?? "Documentation";

  const [logo, font] = await Promise.all([
    loadPublicFile("logo-dark.svg"),
    loadInterFont(),
  ]);

  return createDocsOGImage(title, logo as OGImageLogo, font);
}
```

### Pomocné funkce

| Funkce | Popis |
|----------|-------------|
| `loadPublicFile(path)` | Načte soubor z `public/` jako data URL a buffer; u souborů SVG také načte atributy `width` a `height` |
| `loadInterFont(path?)` | Načte písmo z `public/` pro obrázky OG, ve výchozím nastavení `fonts/Inter-Medium.ttf` |
| `ogImageSize` | Standardní rozměry obrázku OG `{ width: 1200, height: 630 }` |
| `ogImageContentType` | Typ MIME `"image/png"` |

**Požadované soubory:**
- `public/logo-dark.svg` – logo pro obrázky OG. Pomocné funkce OG určují jeho velikost podle atributů `width` a `height`, takže značka `<svg>` musí obsahovat obě hodnoty jako prostá čísla.
- `public/fonts/Inter-Medium.ttf` – písmo pro nadpisy. Onedocs jej nedodává.

## LLMs.txt

Generuje soubory LLMs.txt pro asistenty AI.

### generateLLMsText

Generuje stručný obsah LLMs.txt. Přijímá zdroj obalený pomocí `createLLMsSource` a `{ title, description? }` a vrací promise.

```tsx
// src/app/llms.txt/route.ts
import { createLLMsSource, generateLLMsText } from "onedocs/llms";
import { source } from "@/lib/source";

export async function GET() {
  const content = await generateLLMsText(createLLMsSource(source), {
    title: "My Project",
    description: "Project description",
  });

  return new Response(content, {
    headers: { "Content-Type": "text/plain; charset=utf-8" },
  });
}
```

Adresy URL stránek se zapisují stejně jako ve zdroji, například `/docs/getting-started`, bez domény.

### generateLLMsFullText

Generuje úplný obsah LLMs.txt včetně celého obsahu stránek. Přijímá pouze obalený zdroj a vrací promise.

```tsx
// src/app/llms-full.txt/route.ts
import { createLLMsSource, generateLLMsFullText } from "onedocs/llms";
import { source } from "@/lib/source";

export async function GET() {
  const content = await generateLLMsFullText(createLLMsSource(source));

  return new Response(content, {
    headers: { "Content-Type": "text/plain; charset=utf-8" },
  });
}
```

Těla stránek se zahrnou pouze tehdy, když je zapnutá možnost `includeProcessedMarkdown` v Fumadocs MDX; viz [SEO a vyhledávání](https://onedocs.inline0.dev/cs/docs/seo-search#full-content-version).

### createLLMsSource

Obalí zdroj Fumadocs (výsledek `loader()` nebo `createSource()`) do struktury, kterou čtou obě výše uvedené funkce: každá stránka má URL, název, popis a načítací funkce textu.

## SEO

### generateSitemap

Generuje mapu webu pro vaši dokumentaci. Přijímá jeden objekt: `baseUrl`, seznam `pages` (obvykle z `meta.json`) a volitelné `docsPath` (výchozí `/docs`).

```tsx
// src/app/sitemap.ts
import { generateSitemap } from "onedocs/seo";
import meta from "../../content/docs/meta.json";

export default function sitemap() {
  return generateSitemap({
    baseUrl: "https://example.com",
    pages: meta.pages ?? [],
  });
}
```

Informace o tom, jak se položky mění na adresy URL, najdete v části [SEO a vyhledávání](https://onedocs.inline0.dev/cs/docs/seo-search#sitemap).

### generateRobots

Generuje obsah robots.txt: povolí vše a přidá řádky `Host` a `Sitemap`. Výchozí hodnota `sitemapPath` je `/sitemap.xml`.

```tsx
// src/app/robots.ts
import { generateRobots } from "onedocs/seo";

export default function robots() {
  return generateRobots({
    baseUrl: "https://example.com",
  });
}
```

## Přednastavení CSS

Importujte přednastavení CSS do svého `globals.css`:

```css
@import "onedocs/css/preset.css";

@source "./**/*.tsx";
@source "../../content/**/*.mdx";
```

Cesty `@source` jsou relativní vůči `src/app/globals.css`.

Přednastavení obsahuje:
- Tailwind CSS v4 (`tailwindcss` a `@tailwindcss/postcss` nainstalujte sami)
- Neutrální motiv Fumadocs
- Styly přednastavení Fumadocs
- `--font-sans` nastavené na proměnnou `--font-inter` definovanou v `FontHead`
- Funkce OpenType písmu Inter pro základní text a nadpisy
- Styly rozvržení na celou výšku a úpravy rozvržení Onedocs

## Komponenty MDX

Export `mdxComponents` rozprostře výchozí komponenty Fumadocs UI MDX a přidá níže uvedené komponenty:

```tsx
import { mdxComponents } from "onedocs";

<MDX components={mdxComponents} />
```

**Zahrnuté komponenty:**
- Výchozí komponenty Fumadocs UI: `pre` (bloky kódu), `a`, `img`, `h1` až `h6` (nadpisy s kotvami), `table`, `CodeBlockTab`, `CodeBlockTabs`, `CodeBlockTabsList`, `CodeBlockTabsTrigger`, `CalloutContainer`, `CalloutTitle`, `CalloutDescription`
- `Callout` – informační, varovná a chybová upozornění
- `Card`, `Cards` – rozvržení karet
- `Tab`, `Tabs` – obsah s kartami
- `Step`, `Steps` – číslované kroky
- `Accordion`, `Accordions` – sbalitelné sekce
- `File`, `Folder`, `Files` – stromové struktury souborů
- `ImageZoom` – obrázky se zoomem
- `TypeTable` – tabulky dokumentace typů

`InstallBlock` a `CodeBlock` nejsou zahrnuty; přidejte je sami podle pokynů v části [Komponenty](https://onedocs.inline0.dev/cs/docs/components#more-components).

Příklady použití najdete v části [Komponenty](https://onedocs.inline0.dev/cs/docs/components).