**Параметры, описанные на этой странице, применимы только к теме по умолчанию.** Разные темы предполагают разные конфигурации темы. При использовании пользовательской темы объект конфигурации темы будет передан теме, чтобы она могла определить условное поведение на его основе.
**Параметры, описанные на этой странице, применимы только к теме по умолчанию.** Разные темы предполагают разные конфигурации темы. При использовании пользовательской темы объект конфигурации темы будет передан теме, чтобы она могла определить условное поведение на его основе.
## i18nRouting {#i18nrouting}
## i18nRouting
- Тип: `boolean`
- Тип: `boolean`
При смене локали на `ru` URL изменится с`/foo` (или `/en/foo/`) на `/ru/foo`. Вы можете отключить это поведение, установив для параметра `themeConfig.i18nRouting` значение `false`.
При смене локали на `ru` URL изменится с`/foo` (или `/en/foo/`) на `/ru/foo`. Вы можете отключить это поведение, установив для параметра `themeConfig.i18nRouting` значение `false`.
Подробнее в главе [Тема по умолчанию: Carbon Ads](./default-theme-carbon-ads)
Подробнее в главе [Тема по умолчанию: Carbon Ads](./default-theme-carbon-ads)
## docFooter {#docfooter}
## docFooter
- Тип: `DocFooter`
- Тип: `DocFooter`
@ -388,47 +402,47 @@ export interface DocFooter {
}
}
```
```
## darkModeSwitchLabel {#darkmodeswitchlabel}
## darkModeSwitchLabel
- Тип: `string`
- Тип: `string`
- По умолчанию: `Appearance`
- По умолчанию: `Appearance`
Можно использовать для настройки надписи переключателя тёмного режима. Этот ярлык отображается только в мобильном представлении.
Можно использовать для настройки надписи переключателя тёмного режима. Этот ярлык отображается только в мобильном представлении.
## lightModeSwitchTitle {#lightmodeswitchtitle}
## lightModeSwitchTitle
- Тип: `string`
- Тип: `string`
- По умолчанию: `Switch to light theme`
- По умолчанию: `Switch to light theme`
Может использоваться для настройки заголовка переключателя светлого режима, который появляется при наведении курсора.
Может использоваться для настройки заголовка переключателя светлого режима, который появляется при наведении курсора.
## darkModeSwitchTitle {#darkmodeswitchtitle}
## darkModeSwitchTitle
- Тип: `string`
- Тип: `string`
- По умолчанию: `Switch to dark theme`
- По умолчанию: `Switch to dark theme`
Можно использовать для настройки заголовка переключателя тёмного режима, который появляется при наведении курсора.
Можно использовать для настройки заголовка переключателя тёмного режима, который появляется при наведении курсора.
## sidebarMenuLabel {#sidebarmenulabel}
## sidebarMenuLabel
- Тип: `string`
- Тип: `string`
- По умолчанию: `Menu`
- По умолчанию: `Menu`
Может использоваться для настройки метки бокового меню. Эта метка отображается только в мобильном представлении.
Может использоваться для настройки метки бокового меню. Эта метка отображается только в мобильном представлении.
## returnToTopLabel {#returntotoplabel}
## returnToTopLabel
- Тип: `string`
- Тип: `string`
- По умолчанию: `Return to top`
- По умолчанию: `Return to top`
Может использоваться для настройки метки кнопки возврата наверх. Эта метка отображается только в мобильном представлении.
Может использоваться для настройки метки кнопки возврата наверх. Эта метка отображается только в мобильном представлении.
## langMenuLabel {#langmenulabel}
## langMenuLabel
- Тип: `string`
- Тип: `string`
- По умолчанию: `Change language`
- По умолчанию: `Change language`
Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Это используется только в том случае, если вы используете [i18n](../guide/i18n).
Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Применяется только в том случае, если вы используете [i18n](../guide/i18n).
## skipToContentLabel
## skipToContentLabel
@ -437,9 +451,44 @@ export interface DocFooter {
Можно использовать для настройки метки ссылки перехода к содержимому. Эта ссылка отображается, когда пользователь перемещается по сайту с помощью клавиатуры.
Можно использовать для настройки метки ссылки перехода к содержимому. Эта ссылка отображается, когда пользователь перемещается по сайту с помощью клавиатуры.
## externalLinkIcon {#externallinkicon}
## externalLinkIcon
- Тип: `boolean`
- Тип: `boolean`
- По умолчанию: `false`
- По умолчанию: `false`
Отображать ли значок внешней ссылки рядом с внешними ссылками в Markdown.
Отображать ли значок внешней ссылки рядом с внешними ссылками в Markdown.
@ -46,7 +46,7 @@ titleTemplate: Генератор статических сайтов на ос
---
---
```
```
## description {#description}
## description
- Тип: `string`
- Тип: `string`
@ -58,7 +58,7 @@ description: VitePress
---
---
```
```
## head {#head}
## head
- Тип: `HeadConfig[]`
- Тип: `HeadConfig[]`
@ -86,7 +86,7 @@ type HeadConfig =
Следующие параметры метаданных применимы только при использовании темы по умолчанию.
Следующие параметры метаданных применимы только при использовании темы по умолчанию.
### layout {#layout}
### layout
- Тип: `doc | home | page`
- Тип: `doc | home | page`
- По умолчанию: `doc`
- По умолчанию: `doc`
@ -103,15 +103,15 @@ layout: doc
---
---
```
```
### hero <Badgetype="info"text="только для страниц с макетом home"/> {#hero}
### hero <Badgetype="info"text="только для страниц с макетом home"/>
Определяет содержимое секции `hero`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
Определяет содержимое секции `hero`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
### features <Badgetype="info"text="только для страниц с макетом home"/> {#features}
### features <Badgetype="info"text="только для страниц с макетом home"/>
Определяет элементы для отображения в секции `features`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
Определяет элементы для отображения в секции `features`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
Файл конфигурации всегда разрешается из`<root>/.vitepress/config.[ext]`, где `<root>` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а`[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`.
Конфигурация всегда считывается из файла`<root>/.vitepress/config.[ext]`, где `<root>` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а`[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`.
В файлах конфигурации рекомендуется использовать синтаксис ES-модулей. Файл конфигурации должен по умолчанию экспортировать объект:
В файлах конфигурации рекомендуется использовать синтаксис ES-модулей. Файл конфигурации должен по умолчанию экспортировать объект: