Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

обновлена информация о заголовках #81

Merged
merged 38 commits into from
Dec 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
963dd28
обновлена информация о заголовках
parinovK Dec 17, 2024
30a7fce
проверка минитока
parinovK Dec 17, 2024
8f88afc
правка структуры. Новый раздел. Вернул уровни заголовков в исходное
parinovK Dec 17, 2024
f200599
правки
parinovK Dec 17, 2024
47cdf5a
правки
parinovK Dec 17, 2024
e9309e0
правки
parinovK Dec 17, 2024
85e1a13
правки
parinovK Dec 17, 2024
eafb76b
правки
parinovK Dec 18, 2024
8a13259
правки
parinovK Dec 18, 2024
6cdb8f3
правки
parinovK Dec 18, 2024
17822fb
правки
parinovK Dec 18, 2024
826059b
переписана структура
parinovK Dec 20, 2024
d1a14e9
добавлены скриншоты
parinovK Dec 20, 2024
2d80701
добавлены ассеты
parinovK Dec 20, 2024
9b38c64
заменен ассет с повышенным качеством
parinovK Dec 20, 2024
71316d3
правки
parinovK Dec 20, 2024
bda1135
правки
parinovK Dec 20, 2024
67b9f26
правки
parinovK Dec 20, 2024
1ee6f17
правки
parinovK Dec 20, 2024
2bbb854
правки
parinovK Dec 20, 2024
0da2148
правки
parinovK Dec 20, 2024
2f9e4d3
обновлены ассеты
parinovK Dec 20, 2024
905da12
правки
parinovK Dec 20, 2024
a64ea03
правки
parinovK Dec 20, 2024
83f8341
правки
parinovK Dec 20, 2024
e8fd5b5
правки
parinovK Dec 20, 2024
fa861d2
правки
parinovK Dec 20, 2024
1420664
правки
parinovK Dec 20, 2024
fad00f1
правки
parinovK Dec 20, 2024
2feab69
правки
parinovK Dec 20, 2024
5fafba0
правки
parinovK Dec 20, 2024
9334ca9
правки
parinovK Dec 20, 2024
377f92b
правки
parinovK Dec 20, 2024
cf7e1d6
правки
parinovK Dec 20, 2024
c145fcb
правки
parinovK Dec 20, 2024
6a55866
правки
parinovK Dec 20, 2024
d104297
правки
parinovK Dec 20, 2024
4028c3d
правки
parinovK Dec 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added ru/_images/minitoc_desktop.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ru/_images/minitoc_icon.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ru/_images/minitoc_mobile.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions ru/project/minitoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Оглавление на странице документации

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

{% note warning %}

Оглавление включает заголовки до третьего уровня. Заголовки четвертого уровня и выше в оглавление не попадают.

{% endnote %}

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

{% list tabs accordion %}

- Устройства с большими экранами

Если документация открывается на устройствах с большими экранами, например, на компьютере или ноутбуке, то оглавление будет расположено в правой части документации.

![](../_images/minitoc_desktop.jpg)

- Мобильные устройства

Если документация открывается на мобильных устройствах, то оглавление будет скрыто для экономии места на экране.

Чтобы показать оглавление, нажмите на иконку ![](../_images/minitoc_icon.jpg).

![](../_images/minitoc_mobile.jpg)

{% endlist %}

## Особенности работы с заголовками

### Заголовок первого уровня

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

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

### Оглавление не отображается на странице

Оглавление не будет отображаться на странице, если:

- пропущен один из уровней заголовков;

```markdown
# Заголовок 1
### Заголовок 2
#### Заголовок 3
```

- заголовки выстроены не по возрастанию уровней;

```markdown
# Заголовок 1
### Заголовок 2
## Заголовок 3
```
2 changes: 1 addition & 1 deletion ru/project/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ items:
href: path/to/file.md
```

## Скрытые разделы {#hidden}
### Скрытые разделы {#hidden}

Чтобы раздел был доступен только по прямой ссылке и не попал в оглавление, укажите параметр `hidden`.

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
Loading