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

* обновлена информация о заголовках * проверка минитока * правка структуры. Новый раздел. Вернул уровни заголовков в исходное * правки * правки * правки * правки * правки * правки * правки * правки * переписана структура * добавлены скриншоты * добавлены ассеты * заменен ассет с повышенным качеством * правки * правки * правки * правки * правки * правки * обновлены ассеты * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки * правки
diplodoc-platform · Dec 25, 2024 · a7e1796 · a7e1796
1 parent c0b1aba
commit a7e1796
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 1 deletion.
diff --git a/ru/_images/minitoc_desktop.jpg b/ru/_images/minitoc_desktop.jpg
diff --git a/ru/_images/minitoc_icon.jpg b/ru/_images/minitoc_icon.jpg
diff --git a/ru/_images/minitoc_mobile.jpg b/ru/_images/minitoc_mobile.jpg
diff --git a/ru/project/minitoc.md b/ru/project/minitoc.md
@@ -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
+  ```
diff --git a/ru/project/toc.md b/ru/project/toc.md
@@ -113,7 +113,7 @@ items:
     href: path/to/file.md
 ```
 
-## Скрытые разделы {#hidden}
+### Скрытые разделы {#hidden}
 
 Чтобы раздел был доступен только по прямой ссылке и не попал в оглавление, укажите параметр `hidden`.
 

diff --git a/ru/toc.yaml b/ru/toc.yaml
@@ -104,6 +104,9 @@ items:
             href: project/index.md
           - name: Оглавление
             href: project/toc.md
+            items:
+              - name: Оглавление на странице документации
+                href: project/minitoc.md
           - name: Расширенная навигация
             href: project/navigation.md
           - name: Разводящая страница