# Konfigurace

Nastavení pro celý web patří do `onedocs.config.ts` v kořenové složce projektu. Exportovaný objekt předejte do `DocsLayout`, `HomePage` a `createMetadata`, které jej načítají. Umístění obsahu se nastavuje v `source.config.ts`, nikoli zde (viz [Začínáme](https://onedocs.inline0.dev/cs/docs/getting-started)).

## Základní nastavení

```ts title="onedocs.config.ts"
import { defineConfig } from "onedocs/config";

export default defineConfig({
  title: "My Project",
  description: "Documentation for My Project",
});
```

To je minimum. Vše ostatní je volitelné.

## Úplný příklad

Ikony funkcí jsou prvky React, proto konfigurace, která je používá, musí být soubor `.tsx`:

```tsx title="onedocs.config.tsx"
import { defineConfig } from "onedocs/config";
import { Rocket, Zap } from "lucide-react";

export default defineConfig({
  title: "My Project",
  description: "Documentation for My Project",

  // Logo (string or light/dark variants)
  logo: "/logo.svg",
  // logo: { light: "/logo-light.svg", dark: "/logo-dark.svg" },

  // Favicon (string or light/dark variants), used by createMetadata
  icon: "/icon.png",

  // Navigation bar
  nav: {
    links: [
      { label: "Blog", href: "/blog" },
      { label: "Changelog", href: "/changelog" },
    ],
    github: "username/repo",
  },

  // Homepage
  homepage: {
    hero: {
      title: "My Project",
      description: "Documentation that ships with the code",
      cta: { label: "Get Started", href: "/docs" },
    },
    features: [
      {
        title: "Fast",
        description: "Static pages built by Next.js",
        icon: <Zap className="size-5 text-fd-primary" />,
      },
      {
        title: "Simple",
        description: "Write markdown, get docs",
        icon: <Rocket className="size-5 text-fd-primary" />,
      },
    ],
  },

  // Homepage footer
  footer: {
    links: [{ label: "License", href: "https://github.com/username/repo/blob/main/LICENSE" }],
  },
});
```

## Možnosti

### title (povinné)

Název vašeho webu. Navigační lišta jej zobrazuje, pokud není nastaveno `logo`; `createMetadata` jej používá jako výchozí název stránky i v šabloně `%s | Title` a úvodní stránka jej používá jako název hlavní sekce a v řádku s autorskými právy v patičce.

```ts
title: "My Project"
```

### description

Krátký popis. `createMetadata` jej používá jako meta description a úvodní stránka jej zobrazuje pod názvem hlavní sekce, pokud není nastavena možnost `homepage.hero.description`.

```ts
description: "Documentation for My Project"
```

### logo

Nahrazuje název v navigační liště. Použijte jednu cestu nebo varianty pro světlý a tmavý režim; obrázek je vysoký 24 px a jako alternativní text používá `title`.

```ts
// Single logo
logo: "/logo.svg"

// Light/dark mode
logo: {
  light: "/logo-light.svg",
  dark: "/logo-dark.svg"
}
```

### ikona

Favicon nastavený prostřednictvím `createMetadata`. Varianty pro světlý a tmavý režim se zobrazují pomocí mediálních dotazů `prefers-color-scheme`.

```ts
icon: "/icon.png"

// Light/dark mode
icon: {
  light: "/icon-light.png",
  dark: "/icon-dark.png"
}
```

### navigace

Konfigurace navigační lišty používaná v `DocsLayout` a `HomePage`.

```ts
nav: {
  // Extra links in the navbar
  links: [
    { label: "Blog", href: "/blog" },
    { label: "API", href: "/api" },
  ],

  // GitHub repo as "owner/name" (adds an icon link to https://github.com/owner/name)
  github: "username/repo",
}
```

### domovská stránka

Úvodní sekci a mřížku funkcí vykresluje `HomePage`.

```tsx
homepage: {
  hero: {
    title: "My Project",        // Defaults to config.title
    description: "Description", // Defaults to config.description
    cta: {
      label: "Get Started",     // Default: "Get Started"
      href: "/docs",            // Default: "/docs"
    },
  },
  features: [
    {
      title: "Feature 1",
      description: "Description of feature 1",
      icon: <Rocket className="size-5" />, // Optional React element
    },
  ],
}
```

`icon` se vykreslí přesně tak, jak je zadáno, proto předejte prvek, například ikonu `lucide-react`. Řetězec jako `"rocket"` se vypíše jako text.

Další dvě možnosti úvodní sekce nahrazují části výchozí úvodní sekce:

- `hero.left` nahradí nadpis, popis, blok instalace a tlačítko vlastním obsahem. Přijímá uzel React nebo funkci, která jej vrací.
- `hero.right` vyplní pravou polovinu úvodní sekce. Pod bodem přerušení `lg` se skryje.

### patička

Odkazy a ikony sociálních sítí v zápatí `HomePage` vedle řádku s copyrightem. Obojí se otevírá na nové kartě.

```tsx
// import { GitHubIcon } from "onedocs";
footer: {
  links: [{ label: "Privacy", href: "/privacy" }],
  socials: [
    { label: "GitHub", href: "https://github.com/username/repo", icon: <GitHubIcon /> },
  ],
}
```

Každý odkaz na sociální síť používá jako přístupný název `label`.

## Možnosti, které zatím nemají žádný účinek

`OnedocsConfig` také typuje `docs`, `theme` a `i18n` a `defineConfig` doplňuje výchozí hodnoty `docs.dir` a `theme.darkMode`, ale žádný kód Onedocs je nečte ([#2](https://github.com/inline0/onedocs/issues/2)). Jejich nastavení nic nemění:

- `docs.dir`: složka s obsahem je `dir`, kterou předáte do `defineDocs` v `source.config.ts`.
- `theme.primaryColor` a `theme.darkMode`: barvy pocházejí z motivu Fumadocs UI, který importuje předvolba CSS, a světlý a tmavý režim pocházejí z Fumadocs UI a jeho `RootProvider`.
- `i18n`: Onedocs nepodporuje více jazyků.

## TypeScript

Pomocná funkce `defineConfig` poskytuje úplné automatické doplňování:

```ts
import { defineConfig, type OnedocsConfig } from "onedocs/config";

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

export default defineConfig(config);
```

`defineConfig` vrací předaný objekt a také nepoužívané výchozí hodnoty `docs` a `theme` popsané výše.