📄
← Назад к руководствам

Руководство по синтаксису Markdown: полный справочник с примерами

· Теги: markdown-syntax, markdown-guide, markdown-formatting, github-flavored-markdown, markdown-reference

Руководство по синтаксису Markdown

Markdown — это лёгкий язык разметки, который преобразует простой текст в форматированный HTML. Созданный Джоном Грубером в 2004 году, он стал стандартным форматом написания для документации, файлов README и технического контента по всему вебу.

Заголовки

Используйте символы #. Один # для верхнего уровня, до шести для самого глубокого:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Уровни должны увеличиваться на один — пропуск с ## на #### может запутать экранные читалки.

Форматирование текста

**Bold text** or __Bold text__
*Italic text* or _Italic text_
**_Bold and italic_**
~~Strikethrough text~~

Ссылки

[Link text](https://example.com)
[Link with title](https://example.com "Title")
[Reference-style][ref-id]
[ref-id]: https://example.com
<contact@example.com>

Изображения

![Alt text](/path/to/image.jpg)
[![Alt text](/path/to/image.jpg)](https://example.com)

Альтернативный текст критически важен для доступности и SEO — он отображается, когда изображения не загружаются.

Списки

Неупорядоченные списки используют -, * или +. Упорядоченные списки используют числа:

- Item one         1. First item
- Item two         2. Second item
  - Nested item       1. Nested item

Код

Встроенный код использует одиночные обратные кавычки: `printf()`.

Блоки кода используют тройные обратные кавычки с опциональным идентификатором языка:

```python
def greet(name):
    return f"Hello, {name}!"


Поддерживаемые языки: `javascript`, `python`, `html`, `css`, `json`, `bash`, `sql`, `yaml`.

## Цитаты

```markdown
> This is a blockquote.
> > Nested blockquotes are supported.

Часто используются для выносок, заметок и цитирования внешних источников.

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

Три или более дефиса, звёздочки или подчёркивания на строке:

---
***
___

Таблицы

Вертикальные черты и дефисы определяют столбцы. Двоеточия управляют выравниванием:

| Left | Center | Right |
| :--- | :----: | ----: |
| A1   | B1     | C1    |

Расширения GitHub Flavored Markdown

GitHub Flavored Markdown (GFM) добавляет полезные функции:

- [x] Completed task     # Task lists
- [ ] Incomplete task

:smile: :rocket: :warning:    # Emoji shortcodes

~~Strikethrough text~~        # Strikethrough

GFM также автоматически делает ссылки из URL — www.example.com становится кликабельным без оборачивания в < >.

Экранирование специальных символов

Добавьте префикс \ для отображения буквальных символов Markdown:

\*This is not italic\*
\# This is not a heading

Символы, требующие экранирования: \ ` * _ { } [ ] ( ) # + - . ! | ~.

Предпросмотр Markdown онлайн

Используйте инструмент предпросмотра Markdown, чтобы писать и просматривать Markdown в реальном времени. Живой предпросмотр обновляется по мере ввода, показывая, как именно будут отображаться заголовки, ссылки, изображения, блоки кода и таблицы.

Руководство по синтаксису Markdown: полный справочник с примерами - CoolTool