-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
45 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 заголовок первого уровня зарезервирован в качестве заголовка страницы документации, поэтому: | ||
|
||
- Заголовок первого уровня не попадает в оглавление на странице документации. | ||
- На заголовок первого уровня не получится повесить якорь. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters