Skip to content

Commit 4825271

Browse files
dragomanoHiDeoo
andauthored
i18n(ru): update reference docs (#2259)
Co-authored-by: HiDeoo <494699+HiDeoo@users.noreply.github.com>
1 parent 85ce6ab commit 4825271

File tree

2 files changed

+52
-31
lines changed

2 files changed

+52
-31
lines changed

‎docs/src/content/docs/ru/reference/configuration.mdx

Lines changed: 49 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -100,25 +100,33 @@ starlight({
100100
Настройте элементы навигации боковой панели вашего сайта.
101101

102102
Боковая панель — это массив ссылок и групп ссылок.
103-
Каждый элемент должен иметь метку `label` и одно из следующих свойств:
103+
За исключением элементов, использующих `slug`, каждый элемент должен иметь `label` и одно из следующих свойств:
104104

105-
- `link` - одиночная ссылка на определённый URL, например, `'/home'` или `'https://example.com'`.
105+
- `link` одиночная ссылка на определённый URL, например, `'/home'` или `'https://example.com'`.
106106

107-
- `items` - массив, содержащий дополнительные ссылки и подгруппы боковой панели.
107+
- `slug` — ссылка на внутреннюю страницу, например, `'guides/getting-started'`.
108108

109-
- `autogenerate` - о��ъект, указывающий каталог ваших документов для автоматической генерации группы ссылок.
109+
- `items` — массив, содержащий дополнительные ссылки и подгруппы боковой панели.
110+
111+
- `autogenerate` — объект, указывающий каталог ваших документов для автоматической генерации группы ссылок.
112+
113+
Внутренние ссылки также могут быть указаны в виде строки, а не объекта со свойством `slug`.
110114

111115
```js
112116
starlight({
113117
sidebar: [
114-
// Одиночный элемент ссылки, помеченный как "Главная".
118+
// Одиночный элемент ссылки, помеченный как «Главная».
115119
{ label: 'Главная', link: '/' },
116-
// Группа с надписью "Первые шаги" содержит две ссылки.
120+
// Группа с надписью «Первые шаги» содержит четыре ссылки.
117121
{
118122
label: 'Первые шаги',
119123
items: [
120-
{ label: 'Введение', link: '/intro' },
121-
{ label: 'Следующие шаги', link: '/next-steps' },
124+
// Использование `slug` для внутренних ссылок.
125+
{ slug: 'intro' },
126+
{ slug: 'installation' },
127+
// Или использование сокращения для обозначения внутренних ссылок.
128+
'tutorial',
129+
'next-steps',
122130
],
123131
},
124132
// Группа, связывающая все страницы директории reference.
@@ -141,16 +149,13 @@ starlight({
141149

142150
Автогенерируемые подгруппы по умолчанию уважают свойство `collapsed` своей родительской группы. Установите свойство `autogenerate.collapsed`, чтобы переопределить его.
143151

144-
```js {5,16}
152+
```js {5,13}
145153
sidebar: [
146154
// Группа свёрнутых ссылок.
147155
{
148156
label: 'Свёрнутые ссылки',
149157
collapsed: true,
150-
items: [
151-
{ label: 'Введение', link: '/intro' },
152-
{ label: 'Следующие шаги', link: '/next-steps' },
153-
],
158+
items: ['intro', 'next-steps'],
154159
},
155160
// Развёрнутая группа, содержащая свёрнутые автогенерируемые подгруппы.
156161
{
@@ -192,21 +197,37 @@ sidebar: [
192197
#### `SidebarItem`
193198

194199
```ts
195-
type SidebarItem = {
196-
label: string;
197-
translations?: Record<string, string>;
198-
badge?: string | BadgeConfig;
199-
} & (
200-
| {
201-
link: string;
202-
attrs?: Record<string, string | number | boolean | undefined>;
203-
}
204-
| { items: SidebarItem[]; collapsed?: boolean }
205-
| {
206-
autogenerate: { directory: string; collapsed?: boolean };
207-
collapsed?: boolean;
208-
}
209-
);
200+
type SidebarItem =
201+
| string
202+
| ({
203+
translations?: Record<string, string>;
204+
badge?: string | BadgeConfig;
205+
} & (
206+
| {
207+
// Обычная ссылка
208+
link: string;
209+
label: string;
210+
attrs?: Record<string, string | number | boolean | undefined>;
211+
}
212+
| {
213+
// Внутренняя ссылка
214+
slug: string;
215+
label?: string;
216+
attrs?: Record<string, string | number | boolean | undefined>;
217+
}
218+
| {
219+
// Группа ссылок
220+
label: string;
221+
items: SidebarItem[];
222+
collapsed?: boolean;
223+
}
224+
| {
225+
// Автоматически созданная группа ссылок
226+
label: string;
227+
autogenerate: { directory: string; collapsed?: boolean };
228+
collapsed?: boolean;
229+
}
230+
));
210231
```
211232

212233
#### `BadgeConfig`

‎docs/src/content/docs/ru/reference/frontmatter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ hero:
115115
- text: ��асскажите мне больше
116116
link: /getting-started/
117117
icon: right-arrow
118-
variant: primary
119118
- text: Просмотр на GitHub
120119
link: https://github.com/astronaut/my-project
121120
icon: external
121+
variant: minimal
122122
attrs:
123123
rel: me
124124
---
@@ -166,8 +166,8 @@ interface HeroConfig {
166166
actions?: Array<{
167167
text: string;
168168
link: string;
169-
variant: 'primary' | 'secondary' | 'minimal';
170-
icon: string;
169+
variant?: 'primary' | 'secondary' | 'minimal';
170+
icon?: string;
171171
attrs?: Record<string, string | number | boolean>;
172172
}>;
173173
}

0 commit comments

Comments
 (0)