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 2feab69 commit 5fafba0
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions ru/project/minitoc.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Оглавление на странице документации

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

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

Expand All @@ -22,41 +22,31 @@

{% endlist %}

### Особенности заголовка первого уровня
## Особенности заголовка первого уровня

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

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

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

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

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

В примере ниже пропущен заголовок второго уровня:
- пропущен один из уровней заголовков;

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

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

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

Пример с верным построением заголовков:

```markdown
# Тест1

## Тест2

### Тест3
```

0 comments on commit 5fafba0

Please sign in to comment.