Yaml-import

Импорт yaml-файлов

!!import/single

Импортирует содержимое одного файла

Файл ./vitepress/sidebarNav.yaml
Файл ./platform/sidebarNav.yml
Итог после преобразования

В основном файле бокового меню:

1
...
2

3
"/platform/": !!import/single "../platform/sidebarNav.yml"
4

5
...

Содержимое файла:

1
- text: Платформа MWS
2
  collapsible: false
3
  collapsed: false
4
  items:
5
    - text: Начало работы
6
      link: "/platform/quickstart"
7
    - text: Стадии готовности сервисов
8
      link: "/platform/general/launch-stages"
9
    - text: Взаимодействие пользователей и ресурсов
10
      link: "/platform/iam-rm"
11
    - text: Регионы и зоны доступности
12
      link: "/platform/general/regions-and-zones"

1
...
2

3
"/platform/":
4
  - text: Платформа MWS
5
    collapsible: false
6
    collapsed: false
7
    items:
8
      - text: Начало работы
9
        link: "/platform/quickstart"
10
      - text: Стадии готовности сервисов
11
        link: "/platform/general/launch-stages"
12
      - text: Взаимодействие пользователей и ресурсов
13
        link: "/platform/iam-rm"
14
      - text: Регионы и зоны доступности
15
        link: "/platform/general/regions-and-zones"
16

17
...

Пример с подключением нескольких файлов:

Файл ./vitepress/sidebarNav.yaml
Файлы в папке ./rm/
Итог после преобразования

В основном файле бокового меню:

1
...
2

3
"/rm/":
4
  - text: Управление ресурсами
5
    collapsible: true
6
    collapsed: false
7
    items: !!import/single "../rm/sidebarNavResources.yml"
8
  - text: Обзор
9
    collapsible: true
10
    collapsed: false
11
    items: !!import/single "../rm/sidebarNavOverview.yml"
12
  - text: Инструкции
13
    collapsible: true
14
    collapsed: false
15
    items: !!import/single "../rm/sidebarNavInstructions.yml"
16
...

Содержимое файла ./rm/sidebarNavResources.yml:

1
- text: О сервисе
2
  link: "/rm/about"
3
- text: Начало работы с ресурсами
4
  link: "/rm/quickstart"

Содержимое файла ./rm/sidebarNavOverview.yml:

1
- text: Ресурсная модель
2
  link: "/rm/general/res-model"

Содержимое файла ./rm/sidebarNavInstructions.yml:

1
- text: Управление организациями
2
  link: "/rm/operations/org-manage"
3
- text: Управление проектами
4
  link: "/rm/operations/proj-manage"
5
- text: Управление ресурсами проекта
6
  link: "/rm/operations/res-manage"

1
...
2

3
"/rm/":
4
  - text: Управление ресурсами
5
    collapsible: true
6
    collapsed: false
7
    items:
8
      - text: О сервисе
9
        link: "/rm/about"
10
      - text: Начало работы с ресурсами
11
        link: "/rm/quickstart"
12
  - text: Обзор
13
    collapsible: true
14
    collapsed: false
15
    items:
16
      - text: Ресурсная модель
17
        link: "/rm/general/res-model"
18
  - text: Инструкции
19
    collapsible: true
20
    collapsed: false
21
    items:
22
      - text: Управление организациями
23
        link: "/rm/operations/org-manage"
24
      - text: Управление проектами
25
        link: "/rm/operations/proj-manage"
26
      - text: Управление ресурсами проекта
27
        link: "/rm/operations/res-manage"
28

29
...

Способы из первого и второго примера можно комбинировать

!!import/payload

Может импортировать содержимое нескольких файлов или директорий. Принимает объект с полями:

paths: Обязательное, string | string[]. Пути для импорта - файлы или директории.
strategy: Опциональное, string. Стратегия объединения 'sequence', 'shallow', 'merge', и 'deep'. По умолчанию: 'merge'.
data: Опциональное. Любые дополнительные данные, которые будут записаны в конец объединенных данных.
recursive: Опциональное, boolean. Следует ли рекурсивно просматривать каталоги из параметра paths. По умолчанию: false.

Файл ./vitepress/sidebarNav.yaml
Файл ./iam/sidebarNav.yml
Итог после преобразования

В основном файле бокового меню:

1
...
2

3
"/iam/": !!import/payload
4
  strategy: deep
5
  paths:
6
    - "../iam/sidebarNav.yml"
7
  data:
8
    - text: Инструкции
9
      collapsible: true
10
      collapsed: false
11
      items:
12
        - text: Добавление и удаление пользователей
13
          link: "/iam/operations/users-manage"
14
        - text: Управление ролями пользователей
15
          link: "/iam/operations/roles-manage"
16

17
...

Содержимое файла:

1
- text: Управление пользователями и доступом
2
  collapsible: true
3
  collapsed: false
4
  items:
5
    - text: О сервисе
6
      link: "/iam/about"
7
    - text: Начало работы c пользователями
8
      link: "/iam/quickstart"
9
- text: Обзор
10
  collapsible: true
11
  collapsed: false
12
  items:
13
    - text: Авторизация и аутентификация
14
      link: "/iam/general/auth"
15
    - text: Ролевая модель
16
      link: "/iam/general/role-model"
17
    - text: Справочник ролей
18
      link: "/iam/general/roles-reference"

1
...
2

3
"/platform/":
4
  - text: Управление пользователями и доступом
5
    collapsible: true
6
    collapsed: false
7
    items:
8
      - text: О сервисе
9
        link: "/iam/about"
10
      - text: Начало работы c пользователями
11
        link: "/iam/quickstart"
12
  - text: Обзор
13
    collapsible: true
14
    collapsed: false
15
    items:
16
      - text: Авторизация и аутентификация
17
        link: "/iam/general/auth"
18
      - text: Ролевая модель
19
        link: "/iam/general/role-model"
20
      - text: Справочник ролей
21
        link: "/iam/general/roles-reference"
22
  - text: Инструкции
23
    collapsible: true
24
    collapsed: false
25
    items:
26
      - text: Добавление и удаление пользователей
27
        link: "/iam/operations/users-manage"
28
      - text: Управление ролями пользователей
29
        link: "/iam/operations/roles-manage"
30

31
...