Как использовать Markdown

Здесь все, что есть в Предыдущая страница, работает.На этой странице описаны дополнительные функции, которые VitePress добавляет сверху, а также соглашения, которым мы следуем в этом репозитории.

Frontmatter

Блок в самом верху файла, огражденный тремя черточками, является frontmatter.Он настраивает страницу, а не отображается на ней, и должен быть первым в файле:

---
layout: doc
sidebar: false
aside: false
---

# My Page

Ключи, которые стоит знать:

Ключ	Эффект
layout	doc для обычной страницы, home для целевой страницы
sidebar	false скрывает левую навигацию
aside	false скрывает оглавление на странице справа
title	Переопределяет заголовок вкладки браузера

Большинству страниц вообще не требуется вступительная часть.Добавляйте его только тогда, когда хотите что-то отключить.

Выноски

Это цветные панели, используемые на сайте.Открывается тремя двоеточиями и типом, закрывается тремя двоеточиями:

::: tip
Handy but optional advice.
:::

::: warning
Something the reader can get wrong.
:::

::: danger
Something that will break their server or lose their data.
:::

::: info
Extra background that is not needed to follow the steps.
:::

Вы можете присвоить любому из них собственный заголовок, поместив текст после типа:

::: tip RECOMMENDED
This shows "RECOMMENDED" as the box title instead of "TIP".
:::

Используйте их экономно.Страницу, на которой каждый второй абзац заключен в цветную рамку, читать труднее, чем страницу, где ее нет.

Кодовые блоки

Всегда называйте язык после открывающих обратных кавычек.Он включает подсветку синтаксиса и сообщает читателю, что это такое.смотрю:

```bash
steamcmd +вход анонимный +app_update 629800 подтвердить +выйти
```

bash, ini, json, md, js и ts охватывают практически все, что содержится в этих документах.

Выделение отдельных строк

Поместите номера строк в фигурные скобки, чтобы привлечь внимание к части блока:

```ini{2}
[/Script/Mordhau.MordhauGameSession]
MaxSlots=64
ServerName=Мой сервер
```

Windows и Linux рядом

Если шаг зависит от платформы, используйте группу кода, а не записывайте раздел дважды:

::: code-group

```powershell [Windows]
.\steamcmd.exe +вход анонимный +app_update 629800 подтвердить +выйти
```

```bash [Linux]
./steamcmd.sh +вход анонимный +app_update 629800 подтвердить +выйти
```

:::

Читатель получает вкладки и видит только ту, которая ему нужна.

Ссылки между страницами

Внутренние ссылки начинаются с языковой папки и заканчиваются .md:

[Required Tools](/en/contributing/tools)
[RCON Guide](/en/rcon-guide/)

Путь, заканчивающийся на /, указывает на index.md этой папки.

WARNING

Записывайте внутренние ссылки с полным путем от корня сайта, а не относительные, например ../tools.Относительные ссылки разрываются при перемещении страницы, и они ведут себяв превью GitHub иначе, чем на сайте.

Размещая ссылку на страницу в переведенном разделе, следите за тем, чтобы читатель говорил на его языке.С французской страницы ссылка на /fr/rcon-guide/, а не на /en/rcon-guide/.

Images

Поместите файл в ту же папку, что и страница, которая его использует, и свяжите его с корнем сайта:

![Server browser showing a custom server](/en/dedicated-server-guide/browser.webp)

Сохраняйте скриншоты как .webp, где сможете.Они имеют размер лишь небольшую часть размера PNG того же качества, и этот репозиторий уже достаточно велик.

Добавление новой страницы

Создание файла — это только половина дела: страницы, на которую никто не может перейти, может и не существовать.

1. Создайте файл .md в правой папке docs/.
2. Откройте .vitepress/config.mts.
3. Найдите локаль, к которой вы добавляете, и добавьте в ее nav или sidebar запись, указывающую на вашу страницу.
4. Запустите npm run docs:dev и перейдите к нему.

Если ваша страница принадлежит каждому языку, сначала добавьте английский, а остальные оставьте для переводчиков.Пустая страница хуже, чем отсутствующая.

Собственный стиль

• — один заголовок # на странице вверху, и он должен соответствовать тому, как страница называется на боковой панели.
• — не пропускайте уровни заголовков — ### должен располагаться под ##, а не непосредственно под #.
• — помещайте пустую строку до и после заголовков, списков, блоков кода и выносок.Markdown прощает это, пока вдруг это не так.
• Используйте обратные кавычки для имен файлов, команд, ключей конфигурации и значений.Game.ini, а не «Game.ini».
• — позвольте Prettier обрабатывать перенос строк.Не добавляйте разрывы строк вручную, чтобы строки были короткими.