Чит-лист - Markdown стиля CommonMark

2023-12-06

CommonMark - это стандартизированная версия Markdown, созданная для решения проблем, связанных с несовместимостями в том, как обрабатывается Markdown. Этот справочник предоставляет краткую справку о наиболее часто используемых функциях Markdown стиля CommonMark.

Заголовки

Уровень 1 Заголовок: # Заголовок 1
Уровень 2 Заголовок: ## Заголовок 2
Уровень 3 Заголовок: ### Заголовок 3

Эмоции текста

Жирный: **жирный** или __жирный__
Курсив: *курсив* или _курсив_
Жирный и курсив: ***жирный и курсив*** или ___жирный и курсив___

Списки

Неупорядоченный список: Начинайте строки с -, + или *
Упорядоченный список: Начинайте строки с номеров, за которыми следует .
```
1. Первый пункт
2. Второй пункт
```

Ссылки и изображения

Ссылка: [Текст ссылки](URL)
Изображение: ![ALT текст](URL изображения)

Код

Встроенный код: Оберните текст обратными кавычками `
Блок кода: Оберните текст тремя обратными кавычками (```) или отступите на четыре пробела

```markdown блок кода ```

Цитаты

Начинайте строку с >, за которым следует пробел
```
> Это цитата.
```

Таблицы

Используйте вертикальные черты | для создания столбцов и дефисы - для создания заголовков

| Заголовок 1 | Заголовок 2 |
| -------- | -------- |
| Строка 1    | Данные 1   |
| Строка 2    | Данные 2   |

Горизонтальные правила

Используйте три или более дефиса ---, звездочки *** или нижние подчеркивания ___

Специальные символы

Экранируйте специальные символы Markdown обратной косой чертой \

Стандартизированный подход CommonMark обеспечивает последовательность и переносимость документов Markdown на различных платформах и парсерах.