diff --git a/ru/project/minitoc.md b/ru/project/minitoc.md new file mode 100644 index 0000000..31922c6 --- /dev/null +++ b/ru/project/minitoc.md @@ -0,0 +1,42 @@ +# Оглавление на странице документации + +Оглавление на странице документации — меню навигации по странице, которое расположено справа (посмотреть на мобилках где). Он содержит заголовки всех уровней для удобной навигации по странице. + +Расположение оглавления у десктопной и мобильной версий документации отличается: + +Здесь приложить скриншоты мобильной и полноценной версии. + +{% note warning %} + +Оглавление на странице документации не появится, если пропущен один из уровней заголовков. + +{% list tabs %} + +- Ошибочный пример + + ```markdown + # Тест1 + + ### Тест2 + + ### Тест3 + ``` + +- Верный пример + + ```markdown + # Тест1 + + ## Тест2 + + ### Тест3 + ``` + +{% endlist %} + +{% endnote %} + +В YFM заголовок первого уровня зарезервирован в качестве заголовка страницы документации, поэтому: + +- Заголовок первого уровня не попадает в оглавление на странице документации. +- На заголовок первого уровня не получится повесить якорь. \ No newline at end of file diff --git a/ru/project/toc.md b/ru/project/toc.md index 5719a30..188b2a3 100644 --- a/ru/project/toc.md +++ b/ru/project/toc.md @@ -8,42 +8,6 @@ {% endnote %} -## Миниток на странице документации - -{% note warning %} - -Миниток не появится, если пропущен один из уровней заголовков. - -{% list tabs %} - -- Ошибочный пример - - ```markdown - # Тест1 - - ### Тест2 - - ### Тест3 - ``` - -- Верный пример - ```markdown - # Тест1 - - ## Тест2 - - ### Тест3 - ``` - -{% endlist %} - -{% endnote %} - -В YFM заголовок первого уровня зарезервирован в качестве заголовка страницы документации, поэтому: - -- Заголовок первого уровня не попадает в миниток. -- На заголовок первого уровня не получится повесить якорь. - ## Структура {#structure} Стандартная структура файла `toc.yaml` имеет вид: diff --git a/ru/toc.yaml b/ru/toc.yaml index fbb0a24..6ddcad7 100644 --- a/ru/toc.yaml +++ b/ru/toc.yaml @@ -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: Разводящая страница