Создание страниц и структура

В этом разделе мы разберем, как создавать новые страницы документации и организовывать их в папки.

Создание простой страницы

Чтобы создать новую страницу, просто добавьте файл с расширением .md в папку docs.

Например, создайте файл docs/my-new-page.md:

---
title: Моя новая страница
sidebar_position: 1
---

# Заголовок страницы

Здесь идет текст вашей страницы...

Параметры в начале файла (Front Matter)

В самом начале файла между тройными дефисами --- указываются настройки страницы:

• title: Заголовок страницы (отображается во вкладке браузера и в меню, если не задан sidebar_label).
• sidebar_label: Текст пункта в боковом меню (если нужно, чтобы он отличался от заголовка).
• sidebar_position: Порядковый номер в меню (чем меньше число, тем выше пункт).
• id: Уникальный идентификатор (необязательно, по умолчанию берется из имени файла).
• slug: Кастомный URL страницы (например, slug: /my-custom-url).

Организация структуры (Папки)

Вы можете группировать страницы по папкам. Структура папок автоматически превращается в вложенное меню.

Пример структуры:

docs/
├── intro.md
├── guide/
│   ├── installation.md
│   └── configuration.md
└── api/
    ├── users.md
    └── products.md

Настройка категории (папки)

Чтобы настроить название папки в меню и её порядок, создайте внутри папки файл _category_.json:

{
  "label": "Руководство пользователя",
  "position": 2,
  "link": {
    "type": "generated-index",
    "description": "Описание раздела, которое появится на индексной странице категории."
  }
}

• label: Название категории в меню.
• position: Порядок категории в меню.
• link: Определяет, что произойдет при клике на категорию. generated-index создаст страницу со списком всех статей в этой папке.