Краткий справочник markdown разметки

Материал позаимствован отсюда.

Маркдаун, он же markdown — удобный и быстрый способ разметки текста. Маркдаун используют, если недоступен HTML, а текст нужно сделать читаемым и хотя бы немного размеченным (заголовки, списки, картинки, ссылки).

Главный пример использования маркдауна, с которым мы часто сталкиваемся — файлы readme.md, которые есть в каждом репозитории на Гитхабе. md в имени файла это как раз сокращение от markdown.

Другой частый пример — сообщения в мессенджерах. Можно поставить звёздочки вокруг текста в Телеграме, и текст станет полужирным.

Версии маркдауна отличаются, поэтому перепроверьте, какую вы используете.

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

У нас не очень много вариантов, но есть аналоги тегов <b> и <i>. И их тоже можно вкладывать друг в друга.

Пример:

*Курсивный текст* или _курсивный текст_.
**Полужирный текст** или __полужирный текст__.
**Полужирный _наклонный_ текст_**

Вывод:

Курсивный текст или курсивный текст.

Полужирный текст или полужирный текст.

Полужирный наклонный текст_

Заголовки

Чем больше раз повторяем #, тем больше уровень заголовка. Вообще доступно 6 уровней, но на практике очень редко нужно что-то больше третьего.

Пример:

# Заголовок h1
## Заголовок h2
### Заголовок h3
#### Заголовок h4

Списки

Ненумерованный список

Можно использовать *, + или - с одной стороны. Второй уровень — ставим таб.

Пример:

* Привет
* Как дела
  * После таба получаем вложенный список

Вывод:

• Привет
• Как дела
  • После таба получаем вложенный список

Нумерованный список

С нумерацией вообще смешно — можно просто везде поставить единички, а в документе появится уже нормально проставленная нумерация.

Пример:

1. Да
1. Да-да
    1. Да-да-да-да
    1. Да-да-да-да-да
1. Да-да-да

Вывод:

1. Да
2. Да-да
   1. Да-да-да-да
   2. Да-да-да-да-да
3. Да-да-да

Ссылки

[Текст ссылки](https://modx.pro)

Картинки ставятся как ссылки, только в начале добавляется восклицательный знак.

![Альт-текст](ссылка на картинку)

Цитаты

Пример:

Это обычный текст, а
> Цитируем вот так, и сразу видно, что это цитата

Вывод:

Это обычный текст, а

Цитируем вот так, и сразу видно, что это цитата

Всё, теперь вы можете написать свой первый index.md.

Код

Собственно то, ради чего мы тут все собрались. Код размечается обратными кавычками. Три вначале, три в конце для многострочных блоков или по одной кавычки для простого выделения одного-двух слов.

Пример:

```php
$user = $modx->getObject(modUser::class, ['id' => 5]);
```

Вывод:

$user = $modx->getObject(modUser::class, ['id' => 5]);

Подсветка кода

Markdown поддерживает правильную подсветку кода для различных языков разметки и программирования. Достаточно указать нужный язык после открывающих кавычек. Список поддерживаемых языков достаточно широк. Весь перечень можно посмотреть по этой ссылке.

Кроме того мы добавили подсветку синтаксиса MODX и fenom. Такой классной и удобной подсветки нет даже в официальной документации MODX.

[[!msProducts?
  &parents=`0`
  &includeThumbs=`120x90,360x270`
]]

{'!msProducts' | snippet : [
  'parents' => 0,
  'includeThumbs' => '120x90,360x270',
]}