Skip to content

Commit 3fb3f36

Browse files
authored
docs(ru): update translations (#4708)
* Update ru/reference/default-theme-config.md * Update ru/reference/frontmatter-config.md * Update ru/reference/site-config.md
1 parent fb67f9c commit 3fb3f36

File tree

3 files changed

+100
-38
lines changed

3 files changed

+100
-38
lines changed

docs/ru/reference/default-theme-config.md

Lines changed: 71 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ export default {
1919

2020
**Параметры, описанные на этой странице, применимы только к теме по умолчанию.** Разные темы предполагают разные конфигурации темы. При использовании пользовательской темы объект конфигурации темы будет передан теме, чтобы она могла определить условное поведение на его основе.
2121

22-
## i18nRouting {#i18nrouting}
22+
## i18nRouting
2323

2424
- Тип: `boolean`
2525

2626
При смене локали на `ru` URL изменится с `/foo` (или `/en/foo/`) на `/ru/foo`. Вы можете отключить это поведение, установив для параметра `themeConfig.i18nRouting` значение `false`.
2727

28-
## logo {#logo}
28+
## logo
2929

3030
- Тип: `ThemeableImage`
3131

@@ -46,7 +46,7 @@ type ThemeableImage =
4646
| { light: string; dark: string; alt?: string }
4747
```
4848
49-
## siteTitle {#sitetitle}
49+
## siteTitle
5050
5151
- Тип: `string | false`
5252
@@ -60,7 +60,7 @@ export default {
6060
}
6161
```
6262

63-
## nav {#nav}
63+
## nav
6464

6565
- Тип: `NavItem`
6666

@@ -108,7 +108,7 @@ interface NavItemWithChildren {
108108
}
109109
```
110110

111-
## sidebar {#sidebar}
111+
## sidebar
112112

113113
- Тип: `Sidebar`
114114

@@ -135,7 +135,7 @@ export default {
135135
export type Sidebar = SidebarItem[] | SidebarMulti
136136

137137
export interface SidebarMulti {
138-
[path: string]: SidebarItem[]
138+
[path: string]: SidebarItem[] | { items: SidebarItem[]; base: string }
139139
}
140140

141141
export type SidebarItem = {
@@ -162,10 +162,23 @@ export type SidebarItem = {
162162
* Если `false`, группа сворачивается, но по умолчанию разворачивается
163163
*/
164164
collapsed?: boolean
165+
166+
/**
167+
* Базовый путь для дочерних элементов
168+
*/
169+
base?: string
170+
171+
/**
172+
* Настройте текст, который отображается в футере предыдущей/следующей страницы
173+
*/
174+
docFooterText?: string
175+
176+
rel?: string
177+
target?: string
165178
}
166179
```
167180
168-
## aside {#aside}
181+
## aside
169182
170183
- Тип: `boolean | 'left'`
171184
- По умолчанию: `true`
@@ -177,7 +190,7 @@ export type SidebarItem = {
177190
178191
Если вы хотите отключить его для всех режимов просмотра, используйте `aside: false`.
179192
180-
## outline {#outline}
193+
## outline
181194
182195
- Тип: `Outline | Outline['level'] | false`
183196
- Уровень можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#outline)
@@ -205,7 +218,7 @@ interface Outline {
205218
}
206219
```
207220

208-
## socialLinks {#sociallinks}
221+
## socialLinks
209222

210223
- Тип: `SocialLink[]`
211224

@@ -215,6 +228,7 @@ interface Outline {
215228
export default {
216229
themeConfig: {
217230
socialLinks: [
231+
// Можно добавить любую иконку из simple-icons (https://simpleicons.org/):
218232
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' },
219233
{ icon: 'twitter', link: '...' },
220234
// Можно добавить пользовательские иконки, передав SVG в виде строки:
@@ -239,7 +253,7 @@ interface SocialLink {
239253
}
240254
```
241255

242-
## footer {#footer}
256+
## footer
243257

244258
- Тип: `Footer`
245259
- Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#footer)
@@ -264,7 +278,7 @@ export interface Footer {
264278
}
265279
```
266280

267-
## editLink {#editlink}
281+
## editLink
268282

269283
- Тип: `EditLink`
270284
- Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#editlink)
@@ -289,7 +303,7 @@ export interface EditLink {
289303
}
290304
```
291305

292-
## lastUpdated {#lastupdated}
306+
## lastUpdated
293307

294308
- Тип: `LastUpdatedOptions`
295309

@@ -324,7 +338,7 @@ export interface LastUpdatedOptions {
324338
}
325339
```
326340

327-
## algolia {#algolia}
341+
## algolia
328342

329343
- Тип: `AlgoliaSearch`
330344

@@ -364,7 +378,7 @@ export interface CarbonAdsOptions {
364378

365379
Подробнее в главе [Тема по умолчанию: Carbon Ads](./default-theme-carbon-ads)
366380

367-
## docFooter {#docfooter}
381+
## docFooter
368382

369383
- Тип: `DocFooter`
370384

@@ -388,47 +402,47 @@ export interface DocFooter {
388402
}
389403
```
390404

391-
## darkModeSwitchLabel {#darkmodeswitchlabel}
405+
## darkModeSwitchLabel
392406

393407
- Тип: `string`
394408
- По умолчанию: `Appearance`
395409

396410
Можно использовать для настройки надписи переключателя тёмного режима. Этот ярлык отображается только в мобильном представлении.
397411

398-
## lightModeSwitchTitle {#lightmodeswitchtitle}
412+
## lightModeSwitchTitle
399413

400414
- Тип: `string`
401415
- По умолчанию: `Switch to light theme`
402416

403417
Может использоваться для настройки заголовка переключателя светлого режима, который появляется при наведении курсора.
404418

405-
## darkModeSwitchTitle {#darkmodeswitchtitle}
419+
## darkModeSwitchTitle
406420

407421
- Тип: `string`
408422
- По умолчанию: `Switch to dark theme`
409423

410424
Можно использовать для настройки заголовка переключателя тёмного режима, который появляется при наведении курсора.
411425

412-
## sidebarMenuLabel {#sidebarmenulabel}
426+
## sidebarMenuLabel
413427

414428
- Тип: `string`
415429
- По умолчанию: `Menu`
416430

417431
Может использоваться для настройки метки бокового меню. Эта метка отображается только в мобильном представлении.
418432

419-
## returnToTopLabel {#returntotoplabel}
433+
## returnToTopLabel
420434

421435
- Тип: `string`
422436
- По умолчанию: `Return to top`
423437

424438
Может использоваться для настройки метки кнопки возврата наверх. Эта метка отображается только в мобильном представлении.
425439

426-
## langMenuLabel {#langmenulabel}
440+
## langMenuLabel
427441

428442
- Тип: `string`
429443
- По умолчанию: `Change language`
430444

431-
Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Это используется только в том случае, если вы используете [i18n](../guide/i18n).
445+
Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Применяется только в том случае, если вы используете [i18n](../guide/i18n).
432446

433447
## skipToContentLabel
434448

@@ -437,9 +451,44 @@ export interface DocFooter {
437451

438452
Можно использовать для настройки метки ссылки перехода к содержимому. Эта ссылка отображается, когда пользователь перемещается по сайту с помощью клавиатуры.
439453

440-
## externalLinkIcon {#externallinkicon}
454+
## externalLinkIcon
441455

442456
- Тип: `boolean`
443457
- По умолчанию: `false`
444458

445459
Отображать ли значок внешней ссылки рядом с внешними ссылками в Markdown.
460+
461+
## `useLayout` <Badge type="info" text="composable" />
462+
463+
Возвращает данные, относящиеся к макету. Возвращаемый объект имеет следующий тип:
464+
465+
```ts
466+
interface {
467+
isHome: ComputedRef<boolean>
468+
469+
sidebar: Readonly<ShallowRef<DefaultTheme.SidebarItem[]>>
470+
sidebarGroups: ComputedRef<DefaultTheme.SidebarItem[]>
471+
hasSidebar: ComputedRef<boolean>
472+
isSidebarEnabled: ComputedRef<boolean>
473+
474+
hasAside: ComputedRef<boolean>
475+
leftAside: ComputedRef<boolean>
476+
477+
headers: Readonly<ShallowRef<DefaultTheme.OutlineItem[]>>
478+
hasLocalNav: ComputedRef<boolean>
479+
}
480+
```
481+
482+
**Пример:**
483+
484+
```vue
485+
<script setup>
486+
import { useLayout } from 'vitepress/theme'
487+
488+
const { hasSidebar } = useLayout()
489+
</script>
490+
491+
<template>
492+
<div v-if="hasSidebar">Отображается только если есть боковая панель</div>
493+
</template>
494+
```

docs/ru/reference/frontmatter-config.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ editLink: true
2121
{{ $frontmatter.title }}
2222
```
2323

24-
## title {#title}
24+
## title
2525

2626
- Тип: `string`
2727

@@ -33,7 +33,7 @@ title: VitePress
3333
---
3434
```
3535

36-
## titleTemplate {#titletemplate}
36+
## titleTemplate
3737

3838
- Тип: `string | boolean`
3939

@@ -46,7 +46,7 @@ titleTemplate: Генератор статических сайтов на ос
4646
---
4747
```
4848

49-
## description {#description}
49+
## description
5050

5151
- Тип: `string`
5252

@@ -58,7 +58,7 @@ description: VitePress
5858
---
5959
```
6060

61-
## head {#head}
61+
## head
6262

6363
- Тип: `HeadConfig[]`
6464

@@ -86,7 +86,7 @@ type HeadConfig =
8686
8787
Следующие параметры метаданных применимы только при использовании темы по умолчанию.
8888
89-
### layout {#layout}
89+
### layout
9090
9191
- Тип: `doc | home | page`
9292
- По умолчанию: `doc`
@@ -103,15 +103,15 @@ layout: doc
103103
---
104104
```
105105
106-
### hero <Badge type="info" text="только для страниц с макетом home" /> {#hero}
106+
### hero <Badge type="info" text="только для страниц с макетом home" />
107107
108108
Определяет содержимое секции `hero`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
109109
110-
### features <Badge type="info" text="только для страниц с макетом home" /> {#features}
110+
### features <Badge type="info" text="только для страниц с макетом home" />
111111
112112
Определяет элементы для отображения в секции `features`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page).
113113
114-
### navbar {#navbar}
114+
### navbar
115115
116116
- Тип: `boolean`
117117
- По умолчанию: `true`
@@ -124,7 +124,7 @@ navbar: false
124124
---
125125
```
126126
127-
### sidebar {#sidebar}
127+
### sidebar
128128
129129
- Тип: `boolean`
130130
- По умолчанию: `true`
@@ -137,7 +137,7 @@ sidebar: false
137137
---
138138
```
139139
140-
### aside {#aside}
140+
### aside
141141
142142
- Тип: `boolean | 'left'`
143143
- По умолчанию: `true`
@@ -154,7 +154,7 @@ aside: false
154154
---
155155
```
156156
157-
### outline {#outline}
157+
### outline
158158
159159
- Тип: `number | [number, number] | 'deep' | false`
160160
- По умолчанию: `2`
@@ -167,7 +167,7 @@ outline: [2, 4]
167167
---
168168
```
169169
170-
### lastUpdated {#lastupdated}
170+
### lastUpdated
171171
172172
- Тип: `boolean | Date`
173173
- По умолчанию: `true`
@@ -180,7 +180,7 @@ lastUpdated: false
180180
---
181181
```
182182
183-
### editLink {#editlink}
183+
### editLink
184184
185185
- Тип: `boolean`
186186
- По умолчанию: `true`
@@ -193,7 +193,7 @@ editLink: false
193193
---
194194
```
195195
196-
### footer {#footer}
196+
### footer
197197
198198
- Тип: `boolean`
199199
- По умолчанию: `true`
@@ -206,7 +206,7 @@ footer: false
206206
---
207207
```
208208
209-
### pageClass {#pageclass}
209+
### pageClass
210210
211211
- Тип: `string`
212212
@@ -225,3 +225,16 @@ pageClass: custom-page-class
225225
/* стили для конкретной страницы */
226226
}
227227
```
228+
229+
### isHome
230+
231+
- Тип: `boolean`
232+
233+
Стандартная тема полагается на проверки типа `frontmatter.layout === 'home'`, чтобы определить, является ли текущая страница домашней (главной).\
234+
Это полезно, когда вы хотите принудительно показывать элементы домашней страницы в пользовательском макете.
235+
236+
```yaml
237+
---
238+
isHome: true
239+
---
240+
```

0 commit comments

Comments
 (0)