Skip to content

Commit 8c2b0f6

Browse files
authored
i18n(ru): update some guides (#2262)
1 parent 4825271 commit 8c2b0f6

File tree

5 files changed

+157
-33
lines changed

5 files changed

+157
-33
lines changed

‎docs/src/content/docs/ru/guides/components.mdx

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
9191

9292
Синхронизируйте несколько групп вкладок, добавив атрибут `syncKey`.
9393

94-
Все `<Tabs>` на странице с одинаковым значением `syncKey` будут отображать одну и ту же активную метку. Это позволяет вашему читателю выбрать один раз (например, операционную систему или менеджер пакетов) и увидеть, как его выбор отражается на всей странице.
94+
Все `<Tabs>` с одинаковым значением `syncKey` будут отображать одну и ту же активную метку. Это позволит вашему читателю выбрать один раз (например, операционную систему или менеджер пакетов), и видеть, что их выбор сохраняется при переходе по страницам.
9595

9696
Чтобы синхронизировать связанные вкладки, добавьте идентичное свойство `syncKey` к каждому компоненту `<Tabs>` и убедитесь, что все они используют одни и те же метки `<TabItem>`:
9797

@@ -228,6 +228,38 @@ import { LinkCard } from '@astrojs/starlight/components';
228228
<LinkCard title="Компоненты" href="/ru/guides/components/" />
229229
</CardGrid>
230230

231+
### Кнопки-ссылки
232+
233+
Используйте компонент `<LinkButton>` для визуального выделения ссылок, призывающих к действию.
234+
Кнопка-ссылка полезна для направления пользователей к наиболее релевантному или действующему контенту и часто используется на целевых страницах.
235+
236+
`<LinkButton>` требует обязательного атрибута [`href`](https://developer.mozilla.org/ru/docs/Web/HTML/Element/a#href) и по желанию принимает другие атрибуты ссылки, такие как `target`.
237+
238+
Атрибут `icon` может содержать имя [одной из встроенных иконок Starlight](#все-иконки), чтобы включить иконку рядом с текстом.
239+
Атрибут `iconPlacement` можно использовать для размещения иконки перед текстом, задав ему значение `start` (по умолчанию `end`).
240+
241+
Настройте внешний вид кнопки-ссылки с помощью атрибута `variant`, который может быть установлен в значение `primary` (по умолчанию), `secondary` или `minimal`.
242+
243+
```mdx
244+
# src/content/docs/example.mdx
245+
246+
import { LinkButton } from '@astrojs/starlight/components';
247+
248+
<LinkButton href="/ru/getting-started/">Первые шаги</LinkButton>
249+
<LinkButton href="https://docs.astro.build" variant="secondary" icon="external">
250+
Похожие: Astro
251+
</LinkButton>
252+
```
253+
254+
Вышеуказанный код сформирует следующий HTML:
255+
256+
import { LinkButton } from '@astrojs/starlight/components';
257+
258+
<LinkButton href="/ru/getting-started/">Первые шаги</LinkButton>
259+
<LinkButton href="https://docs.astro.build" variant="secondary" icon="external">
260+
Похожие: Astro
261+
</LinkButton>
262+
231263
### Вставки
232264

233265
Вставки полезны для отображения второстепенной информации рядом с основным содержанием страницы.

‎docs/src/content/docs/ru/guides/customization.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ export default defineConfig({
107107
});
108108
```
109109

110+
Узнайте, как [добавить ссылку на карту сайта в `robots.txt`](https://docs.astro.build/ru/guides/integrations-guide/sitemap/#sitemap-link-in-robotstxt) в документации Astro.
111+
110112
## Макеты страниц
111113

112114
По умолчанию страницы Starlight используют макет с боковой панелью и оглавлением, которое показывает заголовки текущей страницы.
@@ -383,7 +385,7 @@ export default defineConfig({
383385
2. Установите пакет для выбранного вами шрифта.
384386
Вы можете найти имя пакета, нажав «Install» на странице шрифта Fontsource.
385387

386-
<Tabs>
388+
<Tabs syncKey="pkg">
387389

388390
<TabItem label="npm">
389391

‎docs/src/content/docs/ru/guides/pages.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -109,26 +109,25 @@ import CustomComponent from './CustomComponent.astro';
109109

110110
##### `sidebar`
111111

112-
**тип:** `SidebarEntry[]`
112+
**тип:** [`SidebarItem[]`](/ru/reference/configuration/#sidebaritem)
113113
**по умолчанию:** боковая панель, созданная на основе [глобальной конфигурации `sidebar`](/ru/reference/configuration/#sidebar)
114114

115115
Предоставление настраиваемой боковой панели навигации для этой страницы.
116116
Если этот параметр не установлен, на странице будет использоваться глобальная боковая панель по умолчанию.
117117

118-
Например, следующая страница заменяет боковую панель по умолчанию ссылкой на домашнюю страницу и группой ссылок на различные созвездия.
119-
Текущая страница на боковой панели устанавливается с помощью свойства `isCurrent`, а к элементу ссылки добавлен дополнительный значок (`badge`).
118+
Например, следующая страница переопределяет стандартную боковую панель со ссылкой на главную страницу и группой ссылок на другие пользовательские страницы.
120119

121120
```astro {3-13}
122121
<StarlightPage
123122
frontmatter={{ title: 'Орион' }}
124123
sidebar={[
125-
{ label: 'Главная', href: '/' },
124+
{ label: 'Главная', link: '/' },
126125
{
127126
label: 'Созвездия',
128127
items: [
129-
{ label: 'Андромеда', href: '/andromeda/' },
130-
{ label: 'Орион', href: '/orion/', isCurrent: true },
131-
{ label: 'Малая Медведица', href: '/ursa-minor/', badge: 'Заглушка' },
128+
{ label: 'Андромеда', link: '/andromeda/' },
129+
{ label: 'Орион', link: '/orion/' },
130+
{ label: 'Малая Медведица', link: '/ursa-minor/', badge: 'Заглушка' },
132131
],
133132
},
134133
]}
@@ -137,6 +136,8 @@ import CustomComponent from './CustomComponent.astro';
137136
</StarlightPage>
138137
```
139138

139+
Подробнее о доступных вариантах настройки боковой панели см. в руководстве [Боковая панель](/ru/guides/sidebar/).
140+
140141
##### `hasSidebar`
141142

142143
**тип:** `boolean`

‎docs/src/content/docs/ru/guides/sidebar.mdx

Lines changed: 112 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,73 @@ import SidebarPreview from '~/components/sidebar-preview.astro';
4949

5050
## Добавление ссылок и групп ссылок
5151

52-
Чтобы настроить свои [ссылки](#ссылки) и [группы ссылок](#группы) (внутри сворачиваемого заголовка) в боковой панели, используйте свойство [`starlight.sidebar`](/ru/reference/configuration/#sidebar) в `astro.config.mjs`.
52+
Чтобы настроить ссылки и группы ссылок на боковой панели (внутри сворачиваемого заголовка), используйте свойство [`starlight.sidebar`](/ru/reference/configuration/#sidebar) в `astro.config.mjs`.
5353

5454
Комбинируя ссылки и группы, вы можете создавать разнообразные макеты боковой панели.
5555

56-
### Ссылки
56+
### Внутренние ссылки
5757

58-
Добавьте ссылку на внутреннюю или внешнюю страницу, используя объект со свойствами `label` и `link`.
58+
Добавьте ссылку на страницу в `src/content/docs/`, используя объект со свойством `slug`.
59+
Заголовок связанной страницы будет использоваться в качестве метки по умолчанию.
60+
61+
Например, со следующей конфигурацией:
62+
63+
```js "slug:"
64+
starlight({
65+
sidebar: [
66+
{ slug: 'constellations/andromeda' },
67+
{ slug: 'constellations/orion' },
68+
],
69+
});
70+
```
71+
72+
И следующей файловой структурой:
73+
74+
<FileTree>
75+
76+
- src/
77+
- content/
78+
- docs/
79+
- constellations/
80+
- andromeda.md
81+
- orion.md
82+
83+
</FileTree>
84+
85+
Будет создана следующая боковая панель:
86+
87+
<SidebarPreview
88+
config={[
89+
{ label: 'Андромеда', link: '' },
90+
{ label: 'Орион', link: '' },
91+
]}
92+
/>
93+
94+
Чтобы переопределить значения, полученные из метаданных связанной страницы, вы можете добавить свойства `label`, [`translations`](#интернационализация) и [`attrs`](#пол��зовательские-html-атрибуты).
95+
96+
См. [Настройка сгенерированных ссылок](#настройка-сгенерированных-ссылок-через-метаданные) для получения более подробной информации об управлении внешним видом боковой панели из метаданных страницы.
97+
98+
#### Сокращенное обозначение внутренних ссылок
99+
100+
Внутренние ссылки также можно определить, указав только строку для обозначения страницы в качестве сокращения.
101+
102+
Например, следующая конфигурация эквивалентна конфигурации выше, в которой используется `slug`:
103+
104+
```js "slug:"
105+
starlight({
106+
sidebar: ['constellations/andromeda', 'constellations/orion'],
107+
});
108+
```
109+
110+
### Другие ссылки
111+
112+
Добавьте ссылку на внешнюю страницу или страницу, не являющуюся документацией, используя объект со свойствами `label` и `link`.
59113

60114
```js "label:" "link:"
61115
starlight({
62116
sidebar: [
63-
// Ссылка на страницу луны Ганимед.
64-
{ label: 'Ганимед', link: '/moons/ganymede/' },
117+
// Ссылка на страницу, не связанную с документацией, на этом сайте.
118+
{ label: 'Meteor Store', link: '/shop/' },
65119
// Внешняя ссылка на веб-сайт NASA.
66120
{ label: 'NASA', link: 'https://www.nasa.gov/' },
67121
],
@@ -72,7 +126,7 @@ starlight({
72126

73127
<SidebarPreview
74128
config={[
75-
{ label: 'Ганимед', link: '' },
129+
{ label: 'Meteor Store', link: '' },
76130
{ label: 'NASA', link: 'https://www.nasa.gov/' },
77131
]}
78132
/>
@@ -93,15 +147,15 @@ starlight({
93147
{
94148
label: 'Созвездия',
95149
items: [
96-
{ label: 'Карина', link: '/constellations/carina/' },
97-
{ label: 'Центавр', link: '/constellations/centaurus/' },
150+
'constellations/carina',
151+
'constellations/centaurus',
98152
// Вложенная группа ссылок для сезонных созвездий.
99153
{
100154
label: 'Сезонные',
101155
items: [
102-
{ label: 'Андромеда', link: '/constellations/andromeda/' },
103-
{ label: 'Орион', link: '/constellations/orion/' },
104-
{ label: 'Малая Медведица', link: '/constellations/ursa-minor/' },
156+
'constellations/andromeda',
157+
'constellations/orion',
158+
'constellations/ursa-minor',
105159
],
106160
},
107161
],
@@ -186,7 +240,7 @@ starlight({
186240
]}
187241
/>
188242

189-
#### Настройка сгенерированных ссылок через метаданные
243+
## Настройка сгенерированных ссылок через метаданные
190244

191245
Используйте [поле `sidebar`](/ru/reference/frontmatter/#sidebar) в метаданных страниц для настройки автоматически генерируемых ссылок.
192246

@@ -228,23 +282,22 @@ sidebar:
228282
/>
229283

230284
:::note
231-
Конфигурация `sidebar` в метаданных используется только для автоматически генерируемых ссылок и будет проигнорирована для вручную определённых ссылок.
285+
Параметр `sidebar` в метаданных используется только для ссылок в автогенерируемых группах и ссылок на документы, заданных с помощью свойства `slug`. Он не применяется к ссылкам, заданным с помощью свойств�� `link`.
232286
:::
233287

234288
## Значки
235289

236290
Ссылки также могут включать свойство `badge` для отображения значка рядом с текстом ссылки.
237291

238-
```js {10,17}
292+
```js {9,16}
239293
starlight({
240294
sidebar: [
241295
{
242296
label: 'Звёзды',
243297
items: [
244298
// Ссылка со значком «Сверхгигант».
245299
{
246-
label: 'Персей',
247-
link: '/stars/persei/',
300+
slug: 'stars/persei',
248301
badge: 'Сверхгигант',
249302
},
250303
],
@@ -303,16 +356,15 @@ starlight({
303356

304357
Кроме того, можно создать собственный стиль значка, задав свойству `class` имя класса CSS.
305358

306-
```js {10}
359+
```js {9}
307360
starlight({
308361
sidebar: [
309362
{
310363
label: 'Звёзды',
311364
items: [
312365
// Ссылка с жёлтым значком «Заглушка»
313366
{
314-
label: 'Сириус',
315-
link: '/stars/sirius/',
367+
slug: 'stars/sirius',
316368
badge: { text: 'Заглушка', variant: 'caution' },
317369
},
318370
],
@@ -401,14 +453,14 @@ starlight({
401453
translations: {
402454
'pt-BR': 'Andrômeda',
403455
},
404-
link: '/constellations/andromeda/',
456+
slug: 'constellations/andromeda',
405457
},
406458
{
407459
label: 'Скорпион',
408460
translations: {
409461
'pt-BR': 'Escorpião',
410462
},
411-
link: '/constellations/scorpius/',
463+
slug: 'constellations/scorpius',
412464
},
413465
],
414466
},
@@ -430,6 +482,44 @@ starlight({
430482
]}
431483
/>
432484

485+
### Интернационализация с внутренними ссылками
486+
487+
[Внутренние ссылки](#внутренние-ссылки) по умолчанию будут автоматически использовать переведённые заголовки страниц из метаданных контента:
488+
489+
```js {9-10}
490+
starlight({
491+
sidebar: [
492+
{
493+
label: 'Созвездия',
494+
translations: {
495+
'pt-BR': 'Constelações',
496+
},
497+
items: [
498+
{ slug: 'constellations/andromeda' },
499+
{ slug: 'constellations/scorpius' },
500+
],
501+
},
502+
],
503+
});
504+
```
505+
506+
При просмотре документации на бразильском португальском языке появится следующая боковая панель:
507+
508+
<SidebarPreview
509+
config={[
510+
{
511+
label: 'Constelações',
512+
items: [
513+
{ label: 'Andrômeda', link: '' },
514+
{ label: 'Escorpião', link: '' },
515+
],
516+
},
517+
]}
518+
/>
519+
520+
На многоязычных сайтах значение `slug` не включает языковую часть URL.
521+
Например, если у вас есть страницы `en/intro` и `pt-br/intro`, при настройке боковой панели в качестве slug будет `intro`.
522+
433523
## Сворачиваемые группы
434524

435525
Группы ссылок могут быть свёрнуты по умолчанию, если установить свойство `collapsed` в `true`.
@@ -442,8 +532,7 @@ starlight({
442532
// Сворачивание группы по умолчанию
443533
collapsed: true,
444534
items: [
445-
{ label: 'Андромеда', link: '/constellations/andromeda/' },
446-
{ label: 'Орион', link: '/constellations/orion/' },
535+
items: ['constellations/andromeda', 'constellations/orion'],
447536
],
448537
},
449538
],

‎docs/src/content/docs/ru/guides/site-search.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ title: Частично проиндексированная страница
5252

5353
1. Установите `@astrojs/starlight-docsearch`:
5454

55-
<Tabs>
55+
<Tabs syncKey="pkg">
5656

5757
<TabItem label="npm">
5858

0 commit comments

Comments
 (0)