Skip to content

Commit

Permalink
переписана структура
Browse files Browse the repository at this point in the history
  • Loading branch information
parinovK committed Dec 20, 2024
1 parent 17822fb commit 826059b
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 36 deletions.
42 changes: 42 additions & 0 deletions ru/project/minitoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Оглавление на странице документации

Оглавление на странице документации — меню навигации по странице, которое расположено справа (посмотреть на мобилках где). Он содержит заголовки всех уровней для удобной навигации по странице.

Расположение оглавления у десктопной и мобильной версий документации отличается:

Здесь приложить скриншоты мобильной и полноценной версии.

{% note warning %}

Оглавление на странице документации не появится, если пропущен один из уровней заголовков.

{% list tabs %}

- Ошибочный пример

```markdown
# Тест1

### Тест2

### Тест3
```

- Верный пример

```markdown
# Тест1

## Тест2

### Тест3
```

{% endlist %}

{% endnote %}

В YFM заголовок первого уровня зарезервирован в качестве заголовка страницы документации, поэтому:

- Заголовок первого уровня не попадает в оглавление на странице документации.
- На заголовок первого уровня не получится повесить якорь.
36 changes: 0 additions & 36 deletions ru/project/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,42 +8,6 @@

{% endnote %}

## Миниток на странице документации

{% note warning %}

Миниток не появится, если пропущен один из уровней заголовков.

{% list tabs %}

- Ошибочный пример

```markdown
# Тест1

### Тест2

### Тест3
```

- Верный пример
```markdown
# Тест1

## Тест2

### Тест3
```

{% endlist %}

{% endnote %}

В YFM заголовок первого уровня зарезервирован в качестве заголовка страницы документации, поэтому:

- Заголовок первого уровня не попадает в миниток.
- На заголовок первого уровня не получится повесить якорь.

## Структура {#structure}

Стандартная структура файла `toc.yaml` имеет вид:
Expand Down
3 changes: 3 additions & 0 deletions ru/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ items:
href: project/index.md
- name: Оглавление
href: project/toc.md
items:
- name: Оглавление на странице документации
href: project/minitoc.md
- name: Расширенная навигация
href: project/navigation.md
- name: Разводящая страница
Expand Down

0 comments on commit 826059b

Please sign in to comment.