Руководство по синтаксису Markdown: от основ до продвинутого уровня
Markdown — это формат написания, который разработчики действительно любят использовать. Никаких кликов по меню форматирования, никакой борьбы с WYSIWYG-редакторами — просто обычный текст с несколькими символами, который конвертируется в чистый HTML. README-файлы, документация, блог-посты, сообщения в чатах и даже эта статья написаны на Markdown.
Просматривайте ваш Markdown в реальном времени с помощью нашего Markdown Previewer — пишите с одной стороны, видьте отформатированный результат с другой.
Базовый синтаксис
Заголовки
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
Используйте заголовки иерархически. Не пропускайте уровни (перескакивание с H1 на H3) — это вредит как читаемости, так и доступности.
Выделение текста
*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~
Ссылки и изображения
[Link text](https://example.com)
[Link with title](https://example.com "Title")
Списки
- Unordered item
- Another item
- Nested item
1. First item
2. Second item
3. Third item
Цитаты
> This is a blockquote.
> It can span multiple lines.
Код
Строчный код
Используйте обратные кавычки для строчного кода: `const x = 42`
Блоки кода
Тройные обратные кавычки с необязательным идентификатором языка:
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
```
Поддерживаемые языки включают javascript, python, json, yaml, html, css, bash и многие другие.
Таблицы
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
Выравнивание:
| Left | Center | Right |
|:-----|:------:|------:|
| L | C | R |
Продвинутый синтаксис
Списки задач
- [x] Completed task
- [ ] Pending task
- [ ] Another task
Сноски
Here is a statement[^1].
[^1]: This is the footnote content.
Списки определений
Term
: Definition of the term
Горизонтальные линии
---
***
___
GitHub Flavored Markdown (GFM)
GitHub расширяет стандартный Markdown полезными возможностями:
- Автоматические ссылки — Голые URL становятся кликабельными
- Списки задач — Чекбоксы в issues и PR
- Таблицы — Синтаксис с вертикальными чертами, показанный выше
- Зачёркивание —
~~deleted text~~ - Подсветка синтаксиса — Раскраска кода по языкам
- Эмодзи —
:smile:превращается в смайлик
Советы по написанию
- Делайте абзацы короткими — максимум 3–5 предложений
- Используйте заголовки для создания сканируемой структуры
- Предпочитайте списки длинным абзацам для шагов или функций
- Добавляйте примеры кода при обсуждении технических концепций
- Регулярно проверяйте результат — наш Markdown Previewer показывает вывод по мере набора
Часто задаваемые вопросы
В чём разница между Markdown и HTML?
Markdown — это упрощённый формат написания, который конвертируется в HTML. Он покрывает наиболее распространённые потребности в форматировании с гораздо меньшим количеством синтаксиса. Вы можете встраивать необработанный HTML в Markdown, когда вам нужны возможности, которые Markdown не поддерживает.
Какой вариант Markdown использовать?
GitHub Flavored Markdown (GFM) — наиболее широко поддерживаемый. Он добавляет таблицы, списки задач и зачёркивание к стандартному Markdown. CommonMark — это стандартизированная спецификация.
Можно ли использовать Markdown для документации?
Безусловно. Markdown — стандарт для README-файлов, вики и сайтов документации. Инструменты вроде MkDocs, Docusaurus и GitBook — все используют Markdown.
Связанные ресурсы
- Markdown vs Rich Text — почему разработчики предпочитают обычный текст
- Руководство по сравнению текстов — сравнение файлов Markdown
- Markdown Previewer — предварительный просмотр Markdown в реальном времени
- Text Diff Checker — сравнение текстовых файлов и файлов Markdown