From 7fd4be172bf2227cf1d3bb2a1061e3c0f5337c43 Mon Sep 17 00:00:00 2001 From: Bugo Date: Thu, 2 May 2024 06:18:54 +0500 Subject: [PATCH 1/4] Update some translations --- docs/src/content/docs/ru/getting-started.mdx | 11 ++-- .../src/content/docs/ru/guides/components.mdx | 54 ++++++++++++++++--- .../docs/ru/guides/css-and-tailwind.mdx | 9 ++-- .../content/docs/ru/guides/customization.mdx | 4 +- docs/src/content/docs/ru/guides/i18n.mdx | 45 +++++++++++----- docs/src/content/docs/ru/guides/pages.mdx | 3 +- .../docs/ru/reference/configuration.mdx | 14 ++++- .../content/docs/ru/reference/frontmatter.md | 15 ++++++ .../content/docs/ru/reference/overrides.md | 14 ++++- .../docs/ru/resources/community-content.mdx | 8 ++- packages/starlight/translations/ru.json | 4 +- 11 files changed, 142 insertions(+), 39 deletions(-) diff --git a/docs/src/content/docs/ru/getting-started.mdx b/docs/src/content/docs/ru/getting-started.mdx index 8276d15b1b6..bcdc7fdc2d3 100644 --- a/docs/src/content/docs/ru/getting-started.mdx +++ b/docs/src/content/docs/ru/getting-started.mdx @@ -15,7 +15,7 @@ Starlight — это полнофункциональная тема для до Вы можете создать новый проект на базе Astro + Starlight, используя следующую команду: - + ```sh @@ -52,7 +52,7 @@ yarn create astro --template starlight Внутри каталога вашего проекта выполните следующую команду, чтобы запустить сервер разработки: - + ```sh @@ -103,7 +103,7 @@ Starlight готов к созданию нового контента или к Starlight является интеграцией Astro и обновляется так же, как любая интеграция @astrojs/\*: - + ```sh @@ -127,10 +127,9 @@ yarn dlx @astrojs/upgrade -Вы можете увидеть полный список изменений, сделанных в каждом релизе, -в [списке изменений Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md). +Вы можете увидеть полный список изменений, сделанных в каждом релизе, в [списке изменений Starlight](https://github.com/withastro/starlight/blob/main/packages/starlight/CHANGELOG.md). -## Устранение проблем с Starlight +## Устранение проблем со Starlight Используйте справочные страницы [конфигурация проекта](/ru/reference/configuration/) и [конфигурация метаданных отдельной страницы](/ru/reference/frontmatter/), чтобы убедиться, что ваш сайт Starlight настроен и работает правильно. См. руководства на боковой панели, чтобы получить помощь в добавлении контента и настройке вашего сайта Starlight. diff --git a/docs/src/content/docs/ru/guides/components.mdx b/docs/src/content/docs/ru/guides/components.mdx index 4960ca356aa..9fe7d533f7e 100644 --- a/docs/src/content/docs/ru/guides/components.mdx +++ b/docs/src/content/docs/ru/guides/components.mdx @@ -87,6 +87,50 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; +#### Синхронизированные вкладки + +Синхронизируйте несколько групп вкладок, добавив атрибут `syncKey`. + +Все `` на странице с одинаковым значением `syncKey` будут отображать одну и ту же активную метку. Это позволяет вашему читателю выбрать один раз (например, операционную систему или менеджер пакетов) и увидеть, как его выбор отражается на всей странице. + +Чтобы синхронизировать связанные вкладки, добавьте идентичное свойство `syncKey` к каждому компоненту `` и убедитесь, что все они используют одни и те же метки ``: + +```mdx 'syncKey="constellations"' +# src/content/docs/example.mdx + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +_Некоторые звёзды:_ + + + Беллатрикс, Ригель, Бетельгейзе + Поллукс, Кастор А, Кастор Б + + +_Некоторые экзопланеты:_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Поллукс b, HAT-P-24b, HD 50554 b + +``` + +Вышеуказанный код сформирует следующий HTML: + +_Некоторые звёзды:_ + + + Беллатрикс, Ригель, Бетельгейзе + Поллукс, Кастор А, Кастор Б + + +_Некоторые экзопланеты:_ + + + HD 34445 b, Gliese 179 b, Wasp-82 b + Поллукс b, HAT-P-24b, HD 50554 b + + ### Карточки import { Card, CardGrid } from '@astrojs/starlight/components'; @@ -158,10 +202,7 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components'; /> - + ``` @@ -177,10 +218,7 @@ import { LinkCard } from '@astrojs/starlight/components'; /> - + diff --git a/docs/src/content/docs/ru/guides/css-and-tailwind.mdx b/docs/src/content/docs/ru/guides/css-and-tailwind.mdx index 4cc7ec26db1..6f07eadce3c 100644 --- a/docs/src/content/docs/ru/guides/css-and-tailwind.mdx +++ b/docs/src/content/docs/ru/guides/css-and-tailwind.mdx @@ -63,7 +63,7 @@ Starlight предоставляет дополнительный плагин T Создайте новый проект Starlight с предварительно настроенным Tailwind CSS, используя `create astro`: - + ```sh @@ -95,7 +95,7 @@ yarn create astro --template starlight/tailwind 1. Добавьте интеграцию Tailwind от Astro: - + @@ -125,7 +125,7 @@ yarn create astro --template starlight/tailwind 2. Установите плагин Tailwind для Starlight: - + @@ -289,8 +289,7 @@ import ThemeDesigner from '~/components/theme-designer.astro'; CSS-файле](#ваши-css-стили), чтобы применить эту тему к вашему сайту. - Приведённый ниже пример [файла конфигурации - Tailwind](#стилизация-starlight-с-использованием-tailwind) включает + Приведённый ниже пример [файла конфигурации Tailwind](#стилизация-starlight-с-использованием-tailwind) включает сгенерированные палитры цветов `accent` и `gray` для использования в объекте конфигурации `theme.extend.colors`. diff --git a/docs/src/content/docs/ru/guides/customization.mdx b/docs/src/content/docs/ru/guides/customization.mdx index 50a5b0de0d2..80f6d923c70 100644 --- a/docs/src/content/docs/ru/guides/customization.mdx +++ b/docs/src/content/docs/ru/guides/customization.mdx @@ -130,7 +130,7 @@ Starlight отображает оглавление на каждой стран По умолчанию заголовки `

` и `

` включены в оглавление. Укажите уровни заголовков, которые нужно включить на всем сайте, с помощью параметров `minHeadingLevel` и `maxHeadingLevel`, в [`tableOfContents`](/ru/reference/configuration/#tableofcontents). Переопределите эти значения для отдельных страниц, добавив свойства в [метаданные `tableOfContents`](/ru/reference/frontmatter/#tableofcontents): - + ```md {4-6} @@ -164,7 +164,7 @@ defineConfig({ Чтобы полностью отключить оглавление, установите параметр `tableOfContents` в значение `false`: - + ```md {4} diff --git a/docs/src/content/docs/ru/guides/i18n.mdx b/docs/src/content/docs/ru/guides/i18n.mdx index 7f445457613..695128105d4 100644 --- a/docs/src/content/docs/ru/guides/i18n.mdx +++ b/docs/src/content/docs/ru/guides/i18n.mdx @@ -13,7 +13,7 @@ Starlight обеспечивает встроенную поддержку мн 1. Сообщите Starlight о поддерживаемых вами языках, передав свойства [`locales`](/ru/reference/configuration/#locales) и [`defaultLocale`](/ru/reference/configuration/#defaultlocale) в интеграцию Starlight: - ```js {9-31} + ```js {9-26} // astro.config.mjs import { defineConfig } from 'astro/config'; import starlight from '@astrojs/starlight'; @@ -34,11 +34,6 @@ Starlight обеспечивает встроенную поддержку мн label: '简体中文', lang: 'zh-CN', }, - // Документация на арабском в `src/content/docs/ar/` - ar: { - label: 'العربية', - dir: 'rtl', - }, // Документация на русском в `src/content/docs/ru/` ru: { label: 'Русский', @@ -60,15 +55,15 @@ Starlight обеспечивает встроенную поддержку мн - src/ - content/ - docs/ - - ar/ - en/ - ru/ + - zh-cn/ 3. Теперь вы можете добавлять контент в свои языковые каталоги. Используйте одно и то же имя файла для связывания страниц на разных языках и воспользуйтесь полным набором функций i18n Starlight, включая резервный контент, уведомления о переводе и многое другое. - Например, создайте `ar/index.md` и `en/index.md` для отображения главной страницы на арабском и английском языках. + Например, создайте `ru/index.md` и `en/index.md` для отображения главной страницы на русском и английском языках. @@ -91,7 +86,7 @@ export default defineConfig({ locales: { root: { label: 'Русский', - lang: 'ru', // lang обязателен для корневых локалей. + lang: 'ru', // параметр lang обязателен для корневых локалей }, en: { label: 'English', @@ -148,6 +143,34 @@ Starlight предполагает, что вы создадите эквива Если перевод для языка ещё не доступен, Starlight покажет читателям контент этой страницы на языке по умолчанию (установленном через `defaultLocale`). Например, если вы ещё не создали французскую версию вашей страницы «О нас» и вашим языком по умолчанию является английский, посетители `/fr/about` увидят английский контент из `/en/about` с уведомлением о том, что эта страница ещё не была переведена. Это помогает вам добавлять контент на вашем языке по умолчанию и постепенно переводить его, когда у ваших переводчиков есть время. +## Перевод заголовка сайта + +По умолчанию Starlight использует одно и то же название сайта для всех языков. +Если вам нужно настроить заголовок для каждой локали, вы можете передать объект [`title`](/reference/configuration/#title-required) в опциях Starlight: + +```diff lang="js" +// astro.config.mjs +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; + +export default defineConfig({ + integrations: [ + starlight({ +- title: 'Моя документация', ++ title: { ++ en: 'My Docs', ++ ru: "Моя документация", ++ }, + defaultLocale: 'ru', + locales: { + en: { label: 'English' }, + ru: { label: 'Русский', lang: 'ru' }, + }, + }), + ], +}); +``` + ## Перевод интерфейса Starlight import LanguagesList from '~/components/languages-list.astro'; @@ -155,9 +178,7 @@ import UIStringsList from '~/components/ui-strings-list.astro'; Кроме размещения переведённых файлов с контентом, Starlight позволяет вам переводить текст интерфейсе (например, заголовок «На этой странице» в оглавлении), чтобы ваши читатели могли полностью погрузиться в ваш сайт на выбранном языке. - — все переведённые строки пользовательского интерфейса -на указанных языках предоставляются «из коробки», и мы приветствуем [вклад в добавление -дополнительных языков по умолчанию](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md). + — все переведённые строки пользовательского интерфейса на указанных языках предоставляются «из коробки», и мы приветствуем [вклад в добавление дополнительных языков по умолчанию](https://github.com/withastro/starlight/blob/main/CONTRIBUTING.md). Вы можете добавить переводы для дополнительных языков, которые вы поддерживаете — или переопределить наши стандартные тексты — через коллекцию данных `i18n`. diff --git a/docs/src/content/docs/ru/guides/pages.mdx b/docs/src/content/docs/ru/guides/pages.mdx index 40a62a59e9f..54c642bcaf0 100644 --- a/docs/src/content/docs/ru/guides/pages.mdx +++ b/docs/src/content/docs/ru/guides/pages.mdx @@ -103,8 +103,9 @@ import CustomComponent from './CustomComponent.astro'; Следующие свойства отличаются от метаданных Markdown: - Свойство [`slug`](/ru/reference/frontmatter/#slug) не поддерживается и устанавливается автоматически на основе URL-адреса пользовательской страницы. -- Для свойства [`editUrl`](/ru/reference/frontmatter/#editurl) требуется URL-адрес для отображения ссылки на редактирование. +- Свойство [`editUrl`](/ru/reference/frontmatter/#editurl) требует указания URL-адреса для отображения ссылки на редактирование. - Свойство [`sidebar`](/ru/reference/frontmatter/#sidebar) для настройки отображения страницы в [автогенерируемых группах ссылок](/ru/reference/configuration/#sidebar) недоступно. Страницы, использующие компонент ``, не являются частью коллекции и не могут быть добавлены в автоматически созданную группу боковой панели. +- Свойство [`draft`](/ru/reference/frontmatter/#draft) лишь отображает [уведомление](/ru/reference/overrides/#draftcontentnotice) о том, что страница является черновиком, но не исключает её автоматически из производственных сборок. ##### `sidebar` diff --git a/docs/src/content/docs/ru/reference/configuration.mdx b/docs/src/content/docs/ru/reference/configuration.mdx index 7ab54a7bba7..c6eb2405302 100644 --- a/docs/src/content/docs/ru/reference/configuration.mdx +++ b/docs/src/content/docs/ru/reference/configuration.mdx @@ -25,10 +25,22 @@ export default defineConfig({ ### `title` (обязательно) -**тип:** `string` +**тип:** `string | Record` Задайте название для вашего сайта. Будет использоваться в метаданных и в заголовке вкладки браузера. +Значение может быть строкой, а для многоязычных сайтов — объектом со значениями для каждой локали. +При использовании объектной формы ключи должны быть тегами BCP-47 (например, `en`, `ru` или `zh-CN`): + +```ts +starlight({ + title: { + en: 'My delightful docs site', + ru: 'Моя восхитительная документация', + }, +}); +``` + ### `description` **тип:** `string` diff --git a/docs/src/content/docs/ru/reference/frontmatter.md b/docs/src/content/docs/ru/reference/frontmatter.md index 644b4ab1220..19d09bbbe40 100644 --- a/docs/src/content/docs/ru/reference/frontmatter.md +++ b/docs/src/content/docs/ru/reference/frontmatter.md @@ -268,6 +268,21 @@ pagefind: false --- ``` +### `draft` + +**тип:** `boolean` +**по умолчанию:** `false` + +Установите, следует ли считать эту страницу черновиком и не включать её в [производственные сборки](https://docs.astro.build/ru/reference/cli-reference/#astro-build) и [группы автогенерируемых ссылок](/ru/guides/sidebar/#autogenerated-groups). Установите значение `true`, чтобы пометить страницу как черновик и сделать её видимой только во время разработки. + +```md +--- +# src/content/docs/example.md +# Исключить эту страницу из производственных сборок +draft: true +--- +``` + ### `sidebar` **тип:** [`SidebarConfig`](#sidebarconfig) diff --git a/docs/src/content/docs/ru/reference/overrides.md b/docs/src/content/docs/ru/reference/overrides.md index a68a2d35ee6..356c6a1bca7 100644 --- a/docs/src/content/docs/ru/reference/overrides.md +++ b/docs/src/content/docs/ru/reference/overrides.md @@ -50,6 +50,12 @@ Starlight будет передавать следующие параметры Базовый путь, по которому обслуживается язык. `undefined` для слагов корневой локали. +#### `siteTitle` + +**тип:** `string` + +Название сайта для локали этой страницы. + #### `slug` **тип:** `string` @@ -218,7 +224,7 @@ entry: { **Стандартный компонент:** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro) Компонент заголовка отображается в верхней части каждой страницы. -По умолчанию отображаются [``](#sitetitle), [``](#search), [``](#socialicons), [``](#themeselect), и [``](#languageselect). +По умолчанию отображаются [``](#sitetitle-1), [``](#search), [``](#socialicons), [``](#themeselect), и [``](#languageselect). #### `SiteTitle` @@ -332,6 +338,12 @@ entry: { Реализации должны обеспечить установку `id="_top"` для элемента `

`, как в реализации по умолчанию. +#### `DraftContentNotice` + +**Стандартный компонент:** [`DraftContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/DraftContentNotice.astro) + +Уведомление, отображаемое пользователям во время разработки, когда текущая страница помечена как черновик. + #### `FallbackContentNotice` **Стандартный компонент:** [`FallbackContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/FallbackContentNotice.astro) diff --git a/docs/src/content/docs/ru/resources/community-content.mdx b/docs/src/content/docs/ru/resources/community-content.mdx index 767a455c25f..a5e5681ecd6 100644 --- a/docs/src/content/docs/ru/resources/community-content.mdx +++ b/docs/src/content/docs/ru/resources/community-content.mdx @@ -123,8 +123,14 @@ import YouTubeGrid from '~/components/youtube-grid.astro'; { href: 'https://www.youtube.com/watch?v=-Ki-1E5gNCk', title: - 'Шаблон документации Astro Starlight (создавайте собственные документы для приложений!)', + 'Шаблон документации Astro Starlight (создаём документацию для пользовательского приложения!)', description: 'Запустите новый сайт Starlight примерно за 5 минут', }, + { + href: 'https://www.youtube.com/watch?v=12o7WxjAxjM', + title: 'Включите документацию Starlight в проект Next.js с помощью прокси', + description: + 'Установите Starlight в подкаталоге проекта сайта на Next.js', + }, ]} /> diff --git a/packages/starlight/translations/ru.json b/packages/starlight/translations/ru.json index ec32905577a..e2efaf7caf8 100644 --- a/packages/starlight/translations/ru.json +++ b/packages/starlight/translations/ru.json @@ -18,10 +18,10 @@ "page.lastUpdated": "Последнее обновление:", "page.previousLink": "Предыдущая", "page.nextLink": "Следующая", - "page.draft": "This content is a draft and will not be included in production builds.", + "page.draft": "Этот контент является черновиком и не будет включён в производственные сборки.", "404.text": "Страница не найдена. Проверьте URL или используйте поиск по сайту.", "aside.note": "Заметка", - "aside.tip": "Знали ли вы?", + "aside.tip": "Совет", "aside.caution": "Осторожно", "aside.danger": "Опасно", "fileTree.directory": "Директория", From 87ccedb904911b527174d497062f12ea721ec161 Mon Sep 17 00:00:00 2001 From: Bugo Date: Thu, 2 May 2024 06:33:12 +0500 Subject: [PATCH 2/4] Fix links --- docs/src/content/docs/ru/guides/i18n.mdx | 2 +- docs/src/content/docs/ru/reference/configuration.mdx | 2 +- docs/src/content/docs/ru/reference/frontmatter.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/ru/guides/i18n.mdx b/docs/src/content/docs/ru/guides/i18n.mdx index 695128105d4..d309eff5126 100644 --- a/docs/src/content/docs/ru/guides/i18n.mdx +++ b/docs/src/content/docs/ru/guides/i18n.mdx @@ -146,7 +146,7 @@ Starlight предполагает, что вы создадите эквива ## Перевод заголовка сайта По умолчанию Starlight использует одно и то же название сайта для всех языков. -Если вам нужно настроить заголовок для каждой локали, вы можете передать объект [`title`](/reference/configuration/#title-required) в опциях Starlight: +Если вам нужно настроить заголовок для каждой локали, вы можете передать объект [`title`](/ru/reference/configuration/#title-обязателен) в опциях Starlight: ```diff lang="js" // astro.config.mjs diff --git a/docs/src/content/docs/ru/reference/configuration.mdx b/docs/src/content/docs/ru/reference/configuration.mdx index c6eb2405302..397c06d84f5 100644 --- a/docs/src/content/docs/ru/reference/configuration.mdx +++ b/docs/src/content/docs/ru/reference/configuration.mdx @@ -23,7 +23,7 @@ export default defineConfig({ Вы можете передать следующие параметры интеграции `starlight`. -### `title` (обязательно) +### `title` (обязателен) **тип:** `string | Record` diff --git a/docs/src/content/docs/ru/reference/frontmatter.md b/docs/src/content/docs/ru/reference/frontmatter.md index 19d09bbbe40..ac56d6239a3 100644 --- a/docs/src/content/docs/ru/reference/frontmatter.md +++ b/docs/src/content/docs/ru/reference/frontmatter.md @@ -273,7 +273,7 @@ pagefind: false **тип:** `boolean` **по умолчанию:** `false` -Установите, следует ли считать эту страницу черновиком и не включать её в [производственные сборки](https://docs.astro.build/ru/reference/cli-reference/#astro-build) и [группы автогенерируемых ссылок](/ru/guides/sidebar/#autogenerated-groups). Установите значение `true`, чтобы пометить страницу как черновик и сделать её видимой только во время разработки. +Установите, следует ли считать эту страницу черновиком и не включать её в [производственные сборки](https://docs.astro.build/ru/reference/cli-reference/#astro-build) и [группы автогенерируемых ссылок](/ru/guides/sidebar/#автогенерируемые-группы). Установите значение `true`, чтобы пометить страницу как черновик и сделать её видимой только во время разработки. ```md --- From 3b8a1eb69fbe9d74a5f0d3fa70881e0ac2fa22d6 Mon Sep 17 00:00:00 2001 From: Bugo Date: Thu, 2 May 2024 14:03:09 +0500 Subject: [PATCH 3/4] Revert changes in ru.json --- packages/starlight/translations/ru.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/starlight/translations/ru.json b/packages/starlight/translations/ru.json index e2efaf7caf8..ec32905577a 100644 --- a/packages/starlight/translations/ru.json +++ b/packages/starlight/translations/ru.json @@ -18,10 +18,10 @@ "page.lastUpdated": "Последнее обновление:", "page.previousLink": "Предыдущая", "page.nextLink": "Следующая", - "page.draft": "Этот контент является черновиком и не будет включён в производственные сборки.", + "page.draft": "This content is a draft and will not be included in production builds.", "404.text": "Страница не найдена. Проверьте URL или используйте поиск по сайту.", "aside.note": "Заметка", - "aside.tip": "Совет", + "aside.tip": "Знали ли вы?", "aside.caution": "Осторожно", "aside.danger": "Опасно", "fileTree.directory": "Директория", From c38ea8ce07095303edf121b995a52b27e3970a6b Mon Sep 17 00:00:00 2001 From: Bugo Date: Thu, 2 May 2024 14:05:02 +0500 Subject: [PATCH 4/4] Update i18n.mdx --- docs/src/content/docs/ru/guides/i18n.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/ru/guides/i18n.mdx b/docs/src/content/docs/ru/guides/i18n.mdx index d309eff5126..48476cdca25 100644 --- a/docs/src/content/docs/ru/guides/i18n.mdx +++ b/docs/src/content/docs/ru/guides/i18n.mdx @@ -158,13 +158,13 @@ export default defineConfig({ starlight({ - title: 'Моя документация', + title: { -+ en: 'My Docs', + ru: "Моя документация", ++ 'zh-CN': '我的文档', + }, defaultLocale: 'ru', locales: { - en: { label: 'English' }, - ru: { label: 'Русский', lang: 'ru' }, + ru: { label: 'Русский' }, + 'zh-cn': { label: '简体中文', lang: 'zh-CN' }, }, }), ],