Руководоство по использованию Короткое описание (в шапке/мета-блоке)
1.21.11 | IP: velora.su
Альт-текст картинки

Руководоство по использованию

Используется в начале .md файла:

Поддерживаемые поля и алиасы:

  • title: заголовок страницы.
  • desc или description: описание страницы.
  • order: сортировка внутри раздела (меньше = выше).
  • slug: URL-часть страницы.
  • icon: иконка в навигации/заголовке (имя из /assets/icons или путь).
  • hideTitle: скрыть h1 страницы (true).
  • header: изображение в шапке страницы.
  • headerAlt: alt-текст изображения.
  • headerHeight: высота (240, 60%, 20rem).
  • headerFit: cover или contain.
  • headerPos: позиция (center, top, left, right, bottom, например top center).
  • headerShadow: тень шапки (false/0 отключает).
  • hideheadervisuals: true: отключает тень шапки (ставит headerShadow=false).

1.1 Настройка разделов (секций)

Для раздела используется index.md внутри папки раздела. В нём работают те же поля front matter (title, desc, order, icon, header...).

2. Ссылки

Внутренние ссылки:

Как начать Главная Раздел How To Play

[[link:/howtoplay/howtostartplay|Как начать]]
[[page:home/index|Главная]]
[[cat:howtoplay|Раздел How To Play]]

Внешние ссылки:

Внешняя ссылка HTTP ссылка

[[https://example.com|Внешняя ссылка]]
[[http://example.com|HTTP ссылка]]

3. Инлайн иконки и изображения

Лого Синтаксис:

[[icon:idea]]
[[icon:idea|h=18|w=18|a=middle]]
[[img:/assets/logo-color.svg|h=22|alt=Лого]]
[[img:idea|h=16|link=/home/]]

Параметры:

  • h: высота (1em по умолчанию).
  • w: ширина.
  • a, align: top, middle, bottom, baseline.
  • alt: alt-текст.
  • link или href: сделать картинку ссылкой.

icon:NAME и img:NAME ищут /assets/icons/NAME.svg или /assets/icons/NAME.png.

4. Цветной текст

Закрытый цвет:

Синий текст Синий текст

<#3e9eff>Синий текст</#3e9eff>
<#3e9eff>Синий текст<.#3e9eff>

Открытый цвет (до <br> или конца абзаца):
Текст до переноса
Обычный текст

<#3e9eff>Текст до переноса<br>Обычный текст

Поддерживается hex-формат: #RGB, #RRGGBB, #RRGGBBAA.

5. Градиентный текст

Мифическая булава Градиент через CSS-переменную

<gradient:#e61f4b:#a51635>Мифическая булава</gradient>
<gradient:var(--accent):#22c55e>Градиент через CSS-переменную</gradient>

Синтаксис:

  • <gradient:цвет1:цвет2>Текст</gradient>
  • если цвет невалидный, используется fallback (var(--accent) и var(--accent2)).

6. Toggle (раскрывающийся блок)

Короткий вариант:

:::toggle Полезные команды
- /spawn
- /home
:::

С мета-полями:

:::toggle
title: Полезные команды
open: true

Можно любой Markdown внутри:
- списки
- `код`
- **форматирование**
:::

Параметры:

  • title: заголовок блока.
  • open: true, 1 или yes для раскрытия по умолчанию.

Поведение:

  • title можно задать сразу в первой строке: :::toggle Мой заголовок
  • если заголовок не указан, используется Подробнее.

7. Callout-блоки

Примечание

Обычный callout с поддержкой Markdown.

Внимание
  • Поддерживаются списки
  • Ссылки
  • Выделение

Параметры:

  • type: note, tip, warning, error.
  • title: заголовок блока.
  • icon: имя иконки или путь к файлу.
  • align: left, center, right.
  • width: ширина (640, 70%, 40rem).
  • Всё остальное внутри блока считается телом и парсится как Markdown.

Значения по умолчанию:

  • type: note
  • align: center
  • width: без ограничения
  • если title не задан:
  • для note -> Примечание
  • для warning -> Предупреждение
  • для tip -> Совет

8. Download-карточка

Скачать архив
151 B
Внутри карта, ресурсы и инструкция.

Параметры:

  • file: путь к файлу (обязательно).
  • label: заголовок карточки, поддерживает inline Markdown.
  • desc или description: описание, поддерживает inline Markdown.
  • icon: имя иконки или путь.
  • align: left, center, right.
  • width: ширина.

Значения по умолчанию:

  • align: center
  • width: без ограничения
  • icon: /assets/download.svg

Примечания:

  • размер файла подтягивается автоматически из public/... (если файл существует);
  • если label не задан, используется имя файла.

9. Обычное изображение (image)

Скриншот спавна
Подпись под изображением

Параметры:

  • src, file, path: источник изображения (обязательно).
  • alt: alt-текст.
  • caption: подпись.
  • link, href: ссылка по клику.
  • align: left, center, right.
  • width: ширина.
  • height: высота.
  • fit: cover или contain (важно, когда задан height).

Значения по умолчанию:

  • align: center
  • fit: contain
  • width/height: авторазмер по изображению

10. Галерея (gallery)

Параметры:

  • align: left, center, right.
  • width: максимальная ширина галереи (число, в пикселях).
  • строки элементов: путь | подпись (подпись опциональна).

Значения по умолчанию:

  • align: center
  • width: авто

12. Форматы значений и ограничения

Размеры (width, height и похожие поля):

  • число: 720 -> автоматически 720px
  • единицы: px, %, vw, vh, rem, em

Цвета:

  • для <gradient:...:...> поддерживаются: hex, rgb()/rgba(), hsl()/hsla(), CSS name, var(--token)
  • для <#...> поддерживается только hex (#RGB, #RGBA, #RRGGBB, #RRGGBBAA)

Комментарии в fenced-блоках:

  • строки, начинающиеся с #, игнорируются в image, gallery, download

Если параметр указан неверно:

  • движок применяет безопасный fallback (или игнорирует значение), не ломая страницу.

11. Комбинированный пример

Полный пример блока страницы
Быстрый старт
  1. Прочитай гайд для новичков.
  2. Скачай клиент:
Скачать клиент
Актуальная версия сборки.
  1. Открой скриншоты:
Wiki • velora.su