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

5 months ago · a791e94e41
parent fb67f9c75f
commit a791e94e41
1 changed files with 71 additions and 22 deletions
--- 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` <Badge type="info" text="composable" />
+
+Возвращает данные, относящиеся к макету. Возвращаемый объект имеет следующий тип:
+
+```ts
+interface {
+  isHome: ComputedRef<boolean>
+
+  sidebar: Readonly<ShallowRef<DefaultTheme.SidebarItem[]>>
+  sidebarGroups: ComputedRef<DefaultTheme.SidebarItem[]>
+  hasSidebar: ComputedRef<boolean>
+  isSidebarEnabled: ComputedRef<boolean>
+
+  hasAside: ComputedRef<boolean>
+  leftAside: ComputedRef<boolean>
+
+  headers: Readonly<ShallowRef<DefaultTheme.OutlineItem[]>>
+  hasLocalNav: ComputedRef<boolean>
+}
+```
+
+**Пример:**
+
+```vue
+<script setup>
+import { useLayout } from 'vitepress/theme'
+
+const { hasSidebar } = useLayout()
+</script>
+
+<template>
+  <div v-if="hasSidebar">Отображается только если есть боковая панель</div>
+</template>
+```