From 3fb3f3633c60da4b59e1cee8815319892d663a02 Mon Sep 17 00:00:00 2001 From: Bugo Date: Mon, 21 Apr 2025 22:36:31 +0500 Subject: [PATCH] docs(ru): update translations (#4708) * Update ru/reference/default-theme-config.md * Update ru/reference/frontmatter-config.md * Update ru/reference/site-config.md --- docs/ru/reference/default-theme-config.md | 93 +++++++++++++++++------ docs/ru/reference/frontmatter-config.md | 43 +++++++---- docs/ru/reference/site-config.md | 2 +- 3 files changed, 100 insertions(+), 38 deletions(-) diff --git a/docs/ru/reference/default-theme-config.md b/docs/ru/reference/default-theme-config.md index 348791c0..2eb95570 100644 --- a/docs/ru/reference/default-theme-config.md +++ b/docs/ru/reference/default-theme-config.md @@ -19,13 +19,13 @@ export default { **Параметры, описанные на этой странице, применимы только к теме по умолчанию.** Разные темы предполагают разные конфигурации темы. При использовании пользовательской темы объект конфигурации темы будет передан теме, чтобы она могла определить условное поведение на его основе. -## i18nRouting {#i18nrouting} +## i18nRouting - Тип: `boolean` При смене локали на `ru` URL изменится с `/foo` (или `/en/foo/`) на `/ru/foo`. Вы можете отключить это поведение, установив для параметра `themeConfig.i18nRouting` значение `false`. -## logo {#logo} +## logo - Тип: `ThemeableImage` @@ -46,7 +46,7 @@ type ThemeableImage = | { light: string; dark: string; alt?: string } ``` -## siteTitle {#sitetitle} +## siteTitle - Тип: `string | false` @@ -60,7 +60,7 @@ export default { } ``` -## nav {#nav} +## nav - Тип: `NavItem` @@ -108,7 +108,7 @@ interface NavItemWithChildren { } ``` -## sidebar {#sidebar} +## sidebar - Тип: `Sidebar` @@ -135,7 +135,7 @@ export default { export type Sidebar = SidebarItem[] | SidebarMulti export interface SidebarMulti { - [path: string]: SidebarItem[] + [path: string]: SidebarItem[] | { items: SidebarItem[]; base: string } } export type SidebarItem = { @@ -162,10 +162,23 @@ export type SidebarItem = { * Если `false`, группа сворачивается, но по умолчанию разворачивается */ collapsed?: boolean + + /** + * Базовый путь для дочерних элементов + */ + base?: string + + /** + * Настройте текст, который отображается в футере предыдущей/следующей страницы + */ + docFooterText?: string + + rel?: string + target?: string } ``` -## aside {#aside} +## aside - Тип: `boolean | 'left'` - По умолчанию: `true` @@ -177,7 +190,7 @@ export type SidebarItem = { Если вы хотите отключить его для всех режимов просмотра, используйте `aside: false`. -## outline {#outline} +## outline - Тип: `Outline | Outline['level'] | false` - Уровень можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#outline) @@ -205,7 +218,7 @@ interface Outline { } ``` -## socialLinks {#sociallinks} +## socialLinks - Тип: `SocialLink[]` @@ -215,6 +228,7 @@ interface Outline { export default { themeConfig: { socialLinks: [ + // Можно добавить любую иконку из simple-icons (https://simpleicons.org/): { icon: 'github', link: 'https://github.com/vuejs/vitepress' }, { icon: 'twitter', link: '...' }, // Можно добавить пользовательские иконки, передав SVG в виде строки: @@ -239,7 +253,7 @@ interface SocialLink { } ``` -## footer {#footer} +## footer - Тип: `Footer` - Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#footer) @@ -264,7 +278,7 @@ export interface Footer { } ``` -## editLink {#editlink} +## editLink - Тип: `EditLink` - Можно переопределить для каждой страницы с помощью [метаданных](./frontmatter-config#editlink) @@ -289,7 +303,7 @@ export interface EditLink { } ``` -## lastUpdated {#lastupdated} +## lastUpdated - Тип: `LastUpdatedOptions` @@ -324,7 +338,7 @@ export interface LastUpdatedOptions { } ``` -## algolia {#algolia} +## algolia - Тип: `AlgoliaSearch` @@ -364,7 +378,7 @@ export interface CarbonAdsOptions { Подробнее в главе [Тема по умолчанию: Carbon Ads](./default-theme-carbon-ads) -## docFooter {#docfooter} +## docFooter - Тип: `DocFooter` @@ -388,47 +402,47 @@ export interface DocFooter { } ``` -## darkModeSwitchLabel {#darkmodeswitchlabel} +## darkModeSwitchLabel - Тип: `string` - По умолчанию: `Appearance` Можно использовать для настройки надписи переключателя тёмного режима. Этот ярлык отображается только в мобильном представлении. -## lightModeSwitchTitle {#lightmodeswitchtitle} +## lightModeSwitchTitle - Тип: `string` - По умолчанию: `Switch to light theme` Может использоваться для настройки заголовка переключателя светлого режима, который появляется при наведении курсора. -## darkModeSwitchTitle {#darkmodeswitchtitle} +## darkModeSwitchTitle - Тип: `string` - По умолчанию: `Switch to dark theme` Можно использовать для настройки заголовка переключателя тёмного режима, который появляется при наведении курсора. -## sidebarMenuLabel {#sidebarmenulabel} +## sidebarMenuLabel - Тип: `string` - По умолчанию: `Menu` Может использоваться для настройки метки бокового меню. Эта метка отображается только в мобильном представлении. -## returnToTopLabel {#returntotoplabel} +## returnToTopLabel - Тип: `string` - По умолчанию: `Return to top` Может использоваться для настройки метки кнопки возврата наверх. Эта метка отображается только в мобильном представлении. -## langMenuLabel {#langmenulabel} +## langMenuLabel - Тип: `string` - По умолчанию: `Change language` -Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Это используется только в том случае, если вы используете [i18n](../guide/i18n). +Можно использовать для настройки aria-метки кнопки переключения языка в панели навигации. Применяется только в том случае, если вы используете [i18n](../guide/i18n). ## skipToContentLabel @@ -437,9 +451,44 @@ export interface DocFooter { Можно использовать для настройки метки ссылки перехода к содержимому. Эта ссылка отображается, когда пользователь перемещается по сайту с помощью клавиатуры. -## externalLinkIcon {#externallinkicon} +## externalLinkIcon - Тип: `boolean` - По умолчанию: `false` Отображать ли значок внешней ссылки рядом с внешними ссылками в Markdown. + +## `useLayout` + +Возвращает данные, относящиеся к макету. Возвращаемый объект имеет следующий тип: + +```ts +interface { + isHome: ComputedRef + + sidebar: Readonly> + sidebarGroups: ComputedRef + hasSidebar: ComputedRef + isSidebarEnabled: ComputedRef + + hasAside: ComputedRef + leftAside: ComputedRef + + headers: Readonly> + hasLocalNav: ComputedRef +} +``` + +**Пример:** + +```vue + + + +``` diff --git a/docs/ru/reference/frontmatter-config.md b/docs/ru/reference/frontmatter-config.md index e16ed837..70151fd7 100644 --- a/docs/ru/reference/frontmatter-config.md +++ b/docs/ru/reference/frontmatter-config.md @@ -21,7 +21,7 @@ editLink: true {{ $frontmatter.title }} ``` -## title {#title} +## title - Тип: `string` @@ -33,7 +33,7 @@ title: VitePress --- ``` -## titleTemplate {#titletemplate} +## titleTemplate - Тип: `string | boolean` @@ -46,7 +46,7 @@ titleTemplate: Генератор статических сайтов на ос --- ``` -## description {#description} +## description - Тип: `string` @@ -58,7 +58,7 @@ description: VitePress --- ``` -## head {#head} +## head - Тип: `HeadConfig[]` @@ -86,7 +86,7 @@ type HeadConfig = Следующие параметры метаданных применимы только при использовании темы по умолчанию. -### layout {#layout} +### layout - Тип: `doc | home | page` - По умолчанию: `doc` @@ -103,15 +103,15 @@ layout: doc --- ``` -### hero {#hero} +### hero Определяет содержимое секции `hero`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page). -### features {#features} +### features Определяет элементы для отображения в секции `features`, когда `layout` имеет значение `home`. Подробнее в главе [Тема по умолчанию: Главная страница](./default-theme-home-page). -### navbar {#navbar} +### navbar - Тип: `boolean` - По умолчанию: `true` @@ -124,7 +124,7 @@ navbar: false --- ``` -### sidebar {#sidebar} +### sidebar - Тип: `boolean` - По умолчанию: `true` @@ -137,7 +137,7 @@ sidebar: false --- ``` -### aside {#aside} +### aside - Тип: `boolean | 'left'` - По умолчанию: `true` @@ -154,7 +154,7 @@ aside: false --- ``` -### outline {#outline} +### outline - Тип: `number | [number, number] | 'deep' | false` - По умолчанию: `2` @@ -167,7 +167,7 @@ outline: [2, 4] --- ``` -### lastUpdated {#lastupdated} +### lastUpdated - Тип: `boolean | Date` - По умолчанию: `true` @@ -180,7 +180,7 @@ lastUpdated: false --- ``` -### editLink {#editlink} +### editLink - Тип: `boolean` - По умолчанию: `true` @@ -193,7 +193,7 @@ editLink: false --- ``` -### footer {#footer} +### footer - Тип: `boolean` - По умолчанию: `true` @@ -206,7 +206,7 @@ footer: false --- ``` -### pageClass {#pageclass} +### pageClass - Тип: `string` @@ -225,3 +225,16 @@ pageClass: custom-page-class /* стили для конкретной страницы */ } ``` + +### isHome + +- Тип: `boolean` + +Стандартная тема полагается на проверки типа `frontmatter.layout === 'home'`, чтобы определить, является ли текущая страница домашней (главной).\ +Это полезно, когда вы хотите принудительно показывать элементы домашней страницы в пользовательском макете. + +```yaml +--- +isHome: true +--- +``` diff --git a/docs/ru/reference/site-config.md b/docs/ru/reference/site-config.md index 8ba3a110..50bd132c 100644 --- a/docs/ru/reference/site-config.md +++ b/docs/ru/reference/site-config.md @@ -10,7 +10,7 @@ outline: deep ### Разрешение конфигурации {#config-resolution} -Файл конфигурации всегда разрешается из `/.vitepress/config.[ext]`, где `` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а `[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`. +Конфигурация всегда считывается из файла `/.vitepress/config.[ext]`, где `` — это корень вашего [проекта](../guide/routing#root-and-source-directory) VitePress, а `[ext]` — одно из поддерживаемых расширений файла. TypeScript поддерживается из коробки. Поддерживаемые расширения включают `.js`, `.ts`, `.mjs` и `.mts`. В файлах конфигурации рекомендуется использовать синтаксис ES-модулей. Файл конфигурации должен по умолчанию экспортировать объект: