> For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt.

# Страница обзора

Обзорная страница отображает обзор всех статей в директории, автоматически извлекая информацию из боковой панели для создания сгруппированного контента.

## Использование

Чтобы включить такую страницу, добавьте `overview: true` в файл `index.md` нужной директории:

```md title="api/index.md"
---
overview: true
title: Обзор API
---

Это обзорная страница API.
```

Страница обзора автоматически считывает конфигурацию боковой панели текущей директории ([конфигурация боковой панели](/rspress-russian/guide/basic/auto-nav-sidebar.md)) и извлекает заголовки статей для генерации сгруппированных карточек.

## Пример

При следующей структуре директорий и конфигурации `_meta.json`:

```tree
docs
└── api
    ├── _meta.json
    ├── index.md        <-- overview: true
    ├── config
    │   ├── _meta.json
    │   ├── basic.mdx
    │   └── theme.mdx
    └── runtime
        ├── _meta.json
        ├── hooks.mdx
        └── context.mdx
```

```mdx title="api/index.md"
---
overview: true
title: Обзор API
---

Это обзорная страница API.
```

```json title="api/_meta.json"
[
  { "type": "file", "name": "index", "label": "API Overview" },
  { "type": "dir", "name": "config", "label": "Config" },
  { "type": "dir", "name": "runtime", "label": "Runtime" }
]
```

Сгенерированная страница обзора выглядит следующим образом:


# Страница обзора

## Config

### [basic](/rspress-russian/#)

- [title](/rspress-russian/##title)
- [description](/rspress-russian/##description)

### [theme](/rspress-russian/#)

- [darkMode](/rspress-russian/##dark-mode)
- [footer](/rspress-russian/##footer)
## Runtime

### [hooks](/rspress-russian/#)

- [usePage](/rspress-russian/##use-page)
- [useSite](/rspress-russian/##use-site)

### [context](/rspress-russian/#)

- [DataContext](/rspress-russian/##data-context)
- [ThemeContext](/rspress-russian/##theme-context)

## Конфигурация

### overviewHeaders

Управляет уровнями заголовков, которые отображаются на странице обзора. По умолчанию — `[2]` (только заголовки h2).

Можно настроить в файле `_meta.json`:

```json title="_meta.json"
[
  {
    "type": "file",
    "name": "component",
    "overviewHeaders": [2, 3]
  }
]
```

Или в блоке метаданных самой статьи:

```md title="component.mdx"
---
overviewHeaders: [2, 3]
---
```

### Вложенные страницы обзора

Подкаталоги также могут иметь собственные страницы обзора — для этого достаточно настроить `overview: true` в файле `index.md` соответствующей поддиректории:

```tree
docs
└── api
    ├── index.md         <-- overview: true
    └── theme
        ├── index.md     <-- overview: true (вложенная страница обзора)
        ├── component.mdx
        └── utils.mdx
```

## Настройка

Если вам нужно полностью настроить содержимое страницы обзора, есть два подхода:

### Подход 1: настройка стилей через кастомную тему

Используйте [кастомную тему](/rspress-russian/guide/basic/custom-theme.md) для изменения стилей компонента [OverviewGroup](/rspress-russian/ui/layout-components/overview-group.md), продолжая использовать встроенную функциональность страницы обзора:

```mdx title="index.mdx"
---
overview: true
---
```

### Подход 2: полностью кастомное содержимое страницы

Используйте компонент [OverviewGroup](/rspress-russian/ui/layout-components/overview-group.md) с `pageType: doc-wide` для настройки макета страницы и определения содержимого самостоятельно:

```mdx title="index.mdx"
---
pageType: doc-wide
---

# Моя кастомная страница обзора

import { OverviewGroup } from '@rspress/core/theme';

<OverviewGroup
  group={{
    name: 'Пользовательская группа',
    items: [
      {
        text: 'Заголовок страницы',
        link: '/path/to/page',
        headers: [
          { id: 'section-1', text: 'Секция 1', depth: 2 },
          { id: 'section-2', text: 'Секция 2', depth: 2 },
        ],
      },
    ],
  }}
/>
```
