Синтаксис Markdown

Документы пишутся на Markdown и отображаются в менеджере через Parsedown в безопасном режиме. Ниже — что поддерживается, что нет, и короткая шпаргалка для тех, кто с Markdown раньше не работал.

Полный справочник: Markdown Guide (разделы «Basic Syntax» и «Extended Syntax»).

Что поддерживается

Заголовки

# Заголовок первого уровня
## Второго уровня
### Третьего уровня

Выделение текста

**жирный**, *курсив*, ~~зачёркнутый~~

Списки

- пункт
- пункт
  - вложенный пункт

1. первый
2. второй

Ссылки и картинки

[текст ссылки](guide/setup.md)
![подпись под картинкой](images/diagram.svg)

Относительные ссылки на .md-файлы открываются внутри mxLocDoc, а относительные картинки отдаются через защищённый connector: mxLocDoc проверяет путь, расширение и размер файла и не выпускает запрос за пределы корня документации. Внешние ссылки и картинки остаются обычными.

Код

Внутри строки — в одинарных обратных кавычках. Блоком — в тройных обратных кавычках, можно указать язык:

```php
echo 'hello';
```

Код показывается моноширинным шрифтом. Подсветка синтаксиса не выполняется.

Цитаты, разделитель и таблицы

> цитата

---

| Колонка | Значение |
|---------|----------|
| A       | 1        |
| B       | 2        |

Что не поддерживается

• Списки задач - [ ] пункт / - [x] пункт — покажутся как обычный текст со скобками.
• Сноски [^1], списки определений, аббревиатуры, инлайн-атрибуты{.класс} — это расширения ParsedownExtra, которых в пакете нет.
• Сырой HTML (<div>, <iframe>, <details> и т.п.) — намеренно экранируется и показывается как текст. Это защита от небезопасного содержимого.
• Подсветка синтаксиса в блоках кода.
• Небезопасные ссылки (javascript: и подобные) вырезаются.

Шпаргалка

Что нужно	Как написать	Результат
Заголовок	## Название	заголовок раздела
Жирный текст	**текст**	текст
Курсив	*текст*	текст
Зачёркнутый	~~текст~~	текст
Список	- пункт	маркированный список
Нумерация	1. пункт	нумерованный список
Ссылка	[текст](адрес)	кликабельная ссылка
Цитата	> текст	блок цитаты

Совет: оставляйте пустую строку между абзацами, заголовками и списками — без неё блоки могут «слипнуться» в один абзац.