From 8f88afc9370a83c47b6d8ea4472dd1892f478564 Mon Sep 17 00:00:00 2001 From: 1scnd_ <62334658+parinovK@users.noreply.github.com> Date: Tue, 17 Dec 2024 16:47:35 +0300 Subject: [PATCH] =?UTF-8?q?=D0=BF=D1=80=D0=B0=D0=B2=D0=BA=D0=B0=20=D1=81?= =?UTF-8?q?=D1=82=D1=80=D1=83=D0=BA=D1=82=D1=83=D1=80=D1=8B.=20=D0=9D?= =?UTF-8?q?=D0=BE=D0=B2=D1=8B=D0=B9=20=D1=80=D0=B0=D0=B7=D0=B4=D0=B5=D0=BB?= =?UTF-8?q?.=20=D0=92=D0=B5=D1=80=D0=BD=D1=83=D0=BB=20=D1=83=D1=80=D0=BE?= =?UTF-8?q?=D0=B2=D0=BD=D0=B8=20=D0=B7=D0=B0=D0=B3=D0=BE=D0=BB=D0=BE=D0=B2?= =?UTF-8?q?=D0=BA=D0=BE=D0=B2=20=D0=B2=20=D0=B8=D1=81=D1=85=D0=BE=D0=B4?= =?UTF-8?q?=D0=BD=D0=BE=D0=B5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ru/project/toc.md | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/ru/project/toc.md b/ru/project/toc.md index 80f8bbc..f43678f 100644 --- a/ru/project/toc.md +++ b/ru/project/toc.md @@ -4,17 +4,38 @@ {% note warning %} -Заголовки первого уровня зарезервированы в качестве заголовка статьи, они не попадают в миниток и на них не получится повесить якорь. +Файлы, которые не указаны в `toc.yaml`, не обрабатываются при сборке. {% endnote %} +## Миниток (Minitoc) + {% note warning %} -Файлы, которые не указаны в `toc.yaml`, не обрабатываются при сборке. +Заголовки первого уровня зарезервированы в качестве заголовка статьи, они не попадают в миниток и на них не получится повесить якорь. {% endnote %} -### Структура {#structure} +Если пропущен один из уровней заголовков, то миниток не появится. + +**Неверный пример** + +# Тест1 + +### Тест2 + +### Тест3 + +**Верный пример** + +# Тест1 + +## Тест2 + +### Тест3 + + +## Структура {#structure} Стандартная структура файла `toc.yaml` имеет вид: @@ -39,7 +60,7 @@ items: * `href` — относительный путь до файла. * `items` — группирующий элемент. -### Условия видимости разделов {#when} +## Условия видимости разделов {#when} Отдельные разделы можно включать или не включать в документ в зависимости от значений [переменных](../syntax/vars.md). Для описания условий видимости используется параметр `when`. @@ -51,7 +72,7 @@ items: when: version == 12 ``` -### Подстановки и условные операторы {#subtitudes} +## Подстановки и условные операторы {#subtitudes} Название документа поддерживает [подстановки](../syntax/vars#subtitudes) и [условные операторы](../syntax/vars#conditions). @@ -65,7 +86,7 @@ title: "not_var{{ title }}" {% endnote %} -### Настройка раскрытия разделов { #expanded } +## Настройка раскрытия разделов { #expanded } По умолчанию все разделы оглавления свернуты. Чтобы важные разделы и страницы в оглавлении всегда были на виду можно использовать параметр `expanded`: @@ -94,7 +115,7 @@ items: {% endnote %} -### Labeled-разделы в навигации {#labeled} +## Labeled-разделы в навигации {#labeled} Специальные заголовки, которые визуально группируют отдельные пункты в оглавлении. @@ -132,7 +153,7 @@ items: Для полного исключения скрытых разделов из сборки используйте [ключ сборки](../tools/docs/settings.md) `--remove-hidden-toc-items=true`. -### Вставки оглавлений {#includes} +## Вставки оглавлений {#includes} Вы можете разбить оглавление на несколько файлов и вставить одно оглавление в другое. Когда это пригодится: * У вас есть блоки оглавления, которые используются в нескольких документах.