К содержимому
Содержание

Быстрый старт#

Создайте файл#

Положите в папку content/ файл с расширением .md. Имя — латиницей, строчными, через дефис: weapon-damage.md. Русское название страницы пишется внутри, в поле title.

Опишите страницу#

В самом верху файла может стоять блок настроек. Он не обязателен.

yaml
---
title: Урон оружия
description: Как считается урон
icon: sword
order: 10
tags: [бой, оружие]
---

Пишите текст#

Работает весь привычный Markdown: заголовки, списки, таблицы, цитаты, сноски, задачи и блоки кода.

damage.lualua
function CalculateDamage(weapon, target)
    local base = weapon.damage
    return base * target.armorMultiplier
end

Ссылайтесь на другие страницы#

Не нужно помнить путь до файла — достаточно названия страницы.

markdown
[[Инвентарь]]
[[Инвентарь#Вес предметов]]
[[Инвентарь|про инвентарь]]

Если страницу переименуют, ссылки починятся сами. Если такой страницы нет — движок сразу скажет об этом в редакторе, а не покажет читателю пустоту.

Вместо HTML — компоненты

Сырой HTML на страницах не работает: он вырезается, а текст остаётся. Всё оформление делается компонентами вроде <Warning>, <Card> и <Image>.

Что дальше#

Посмотрите Инвентарь — это пример настоящей страницы документации.