Skip to content

Commit

Permalink
правка структуры. Новый раздел. Вернул уровни заголовков в исходное
Browse files Browse the repository at this point in the history
  • Loading branch information
parinovK committed Dec 17, 2024
1 parent 30a7fce commit 8f88afc
Showing 1 changed file with 29 additions and 8 deletions.
37 changes: 29 additions & 8 deletions ru/project/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` имеет вид:

Expand All @@ -39,7 +60,7 @@ items:
* `href` — относительный путь до файла.
* `items` — группирующий элемент.

### Условия видимости разделов {#when}
## Условия видимости разделов {#when}

Отдельные разделы можно включать или не включать в документ в зависимости от значений [переменных](../syntax/vars.md). Для описания условий видимости используется параметр `when`.

Expand All @@ -51,7 +72,7 @@ items:
when: version == 12
```

### Подстановки и условные операторы {#subtitudes}
## Подстановки и условные операторы {#subtitudes}

Название документа поддерживает [подстановки](../syntax/vars#subtitudes) и [условные операторы](../syntax/vars#conditions).

Expand All @@ -65,7 +86,7 @@ title: "not_var{{ title }}"

{% endnote %}

### Настройка раскрытия разделов { #expanded }
## Настройка раскрытия разделов { #expanded }

По умолчанию все разделы оглавления свернуты. Чтобы важные разделы и страницы в оглавлении всегда были на виду можно использовать параметр `expanded`:

Expand Down Expand Up @@ -94,7 +115,7 @@ items:
{% endnote %}


### Labeled-разделы в навигации {#labeled}
## Labeled-разделы в навигации {#labeled}

Специальные заголовки, которые визуально группируют отдельные пункты в оглавлении.

Expand Down Expand Up @@ -132,7 +153,7 @@ items:
Для полного исключения скрытых разделов из сборки используйте [ключ сборки](../tools/docs/settings.md) `--remove-hidden-toc-items=true`.


### Вставки оглавлений {#includes}
## Вставки оглавлений {#includes}

Вы можете разбить оглавление на несколько файлов и вставить одно оглавление в другое. Когда это пригодится:
* У вас есть блоки оглавления, которые используются в нескольких документах.
Expand Down

0 comments on commit 8f88afc

Please sign in to comment.