Skip to main content
Эта документация построена на платформе Mintlify. Все страницы пишутся в формате MDX — это Markdown с поддержкой React-компонентов.

Структура страницы

Каждая страница начинается с frontmatter — метаданных в формате YAML между ---:
---
title: "Заголовок страницы"
description: "Краткое описание для SEO"
sidebarTitle: "Короткий заголовок"
icon: "book"
---
ПолеОписание
titleЗаголовок страницы (обязательно)
descriptionОписание для SEO и превью
sidebarTitleКороткий заголовок для боковой панели
iconИконка из Font Awesome или Lucide
tagМетка рядом с заголовком (например, “NEW”)

Форматирование текста

Базовый синтаксис Markdown

**Жирный текст**
*Курсив*
~~Зачёркнутый~~
`inline код`

[Ссылка](https://example.com)
![Картинка](/images/hero-dark.png)
Жирный текст Курсив Зачёркнутый inline код Ссылка Картинка

Заголовки

Используйте заголовки для структурирования контента. Они автоматически появляются в оглавлении справа.
## Заголовок второго уровня
### Заголовок третьего уровня
#### Заголовок четвёртого уровня
Не пропускайте уровни заголовков! Например, не переходите от ## сразу к ####.

Списки

- Маркированный список
- Ещё один пункт
  - Вложенный пункт

1. Нумерованный список
2. Второй пункт
3. Третий пункт
  • Маркированный список
  • Ещё один пункт
    • Вложенный пункт
  1. Нумерованный список
  2. Второй пункт
  3. Третий пункт

Компоненты

Компоненты — это готовые блоки для оформления контента. Подробнее: Mintlify Components

Callouts (выноски)

Используйте для привлечения внимания к важной информации:
<Note>Информационная заметка</Note>
Результат:
Информационная заметка
Полезный совет
Предупреждение

Accordion (аккордеон)

Сворачиваемые секции для длинного контента:
<AccordionGroup>
  <Accordion title="Первый вопрос" icon="circle-question">
    Ответ на первый вопрос
  </Accordion>
  <Accordion title="Второй вопрос">
    Ответ на второй вопрос
  </Accordion>
</AccordionGroup>
Ответ на первый вопрос
Ответ на второй вопрос

Cards (карточки)

Для навигации и выделения разделов:
<CardGroup cols={2}>
  <Card title="Первая карточка" icon="star" href="/page1">
    Описание первой карточки
  </Card>
  <Card title="Вторая карточка" icon="rocket" href="/page2">
    Описание второй карточки
  </Card>
</CardGroup>

Steps (шаги)

Для пошаговых инструкций:
<Steps>
  <Step title="Первый шаг">
    Описание первого шага
  </Step>
  <Step title="Второй шаг">
    Описание второго шага
  </Step>
</Steps>
1

Первый шаг

Описание первого шага
2

Второй шаг

Описание второго шага

Tabs (вкладки)

Для альтернативного контента:
<Tabs>
  <Tab title="Вариант A">
    Контент варианта A
  </Tab>
  <Tab title="Вариант B">
    Контент варианта B
  </Tab>
</Tabs>
Контент варианта A

Блоки кода

Простой блок кода

Используйте тройные обратные кавычки с указанием языка:
```lua
local function hello()
    print("Hello, Ratgore!")
end
```
local function hello()
    print("Hello, Ratgore!")
end

Группа кода

Для примеров на разных языках:
<CodeGroup>
```lua Lua
print("Hello")
```

```python Python
print("Hello")
```
</CodeGroup>
print("Hello")

Изображения

Базовое добавление

![Описание изображения](/images/hero-dark.png)
Описание изображения

С рамкой (Frame)

<Frame>
  <img src="/images/hero-dark.png" alt="Описание" />
</Frame>
Описание
Храните изображения в папке /images, с подпапкой вашей стати, например /images/NCWL/Lore/History. Используйте понятные имена файлов.

Лучшие практики

Структура

  • Один H1 на страницу (title в frontmatter)
  • Логичная иерархия заголовков
  • Короткие абзацы

Стиль

  • Пишите от второго лица (“вы”)
  • Избегайте сложных конструкций
  • Используйте активный залог

Ссылки

  • Описательный текст ссылок
  • Относительные пути для внутренних ссылок
  • Проверяйте битые ссылки

Код

  • Всегда указывайте язык
  • Тестируйте примеры
  • Добавляйте комментарии

Полезные ссылки