Синтаксис Markdown

Полный справочник по синтаксису заголовков, выделения, ссылок, списков, кода, таблиц и многого другого

Headings

Syntax	Shorthand	Example	Rendered	Notes
`# Heading`	`H1`	`# My Title`	H1	Largest heading; maps to <h1>
`## Heading`	`H2`	`## Section`	H2	Maps to <h2>
`### Heading`	`H3`	`### Subsection`	H3	Maps to <h3>
`#### Heading`	`H4`	`#### Detail`	H4	Maps to <h4>
`##### Heading`	`H5`	`##### Note`	H5	Maps to <h5>
`###### Heading`	`H6`	`###### Fine print`	H6	Smallest heading; maps to <h6>

Emphasis

Syntax	Shorthand	Example	Rendered	Notes
`text`	`Bold`	`hello`	hello	Also __text__
`text`	`Italic`	`hello`	hello	Also _text_
`*text*`	`Bold + Italic`	`*hello*`	hello	Also ___text___
`~~text~~`	`Strikethrough`	`~~hello~~`	hello	Requires GFM support
`code`	`Inline code`	`var x = 1`	var x = 1	Monospace; escapes HTML

Links & Images

Syntax	Shorthand	Example	Rendered	Notes
`[text](url)`	`Inline link`	`[Google](https://google.com)`	Google	Opens in same tab by default
`[text](url "title")`	`Link + title`	`[G](https://g.com "Go")`	Google	Title shown on hover
`[text][ref]`	`Reference link`	`[Google][g] ... [g]: url`	Google	Define URL elsewhere in doc
`![alt](url)`	`Inline image`	`![Logo](logo.png)`	<img>	Alt text improves accessibility
`<url>`	`Autolink`	`<https://example.com>`	link	URL or email becomes clickable

Lists

Syntax	Shorthand	Example	Rendered	Notes
`- item`	`Unordered`	`- Apple - Banana`	* Apple	Also * or + as bullet
`1. item`	`Ordered`	`1. First 2. Second`	1. First	Numbers auto-increment in output
`- nested`	`Nested list`	`- Item - Sub`	* Item > Sub	Indent 2+ spaces to nest
`- [ ] task`	`Task (unchecked)`	`- [ ] Todo`	[ ] Todo	GitHub Flavored Markdown
`- [x] task`	`Task (checked)`	`- [x] Done`	[x] Done	GFM checked task item

Code Blocks

Syntax	Shorthand	Example	Rendered	Notes
```lang	`Fenced block`	```js code ```	<pre>	Language hint enables syntax highlight
`code`	`Indented block`	`let x = 1;`	<pre>	4 spaces or 1 tab indentation
`code`	`Inline code`	Use `npm install`	npm install	Single backtick pair

Blockquotes

Syntax	Shorthand	Example	Rendered	Notes
`> text`	`Blockquote`	`> This is a quote`	" quote	Renders as <blockquote>
`>> text`	`Nested quote`	`>> Inner quote`	"" inner	Double > for nested blockquote
`> Note`	`Callout style`	`> Warning: text`	callout	Bold first word for callout pattern

Tables

Syntax	Shorthand	Example	Rendered	Notes
`\| Col \| Col \|`	`Header row`	`\| Name \| Age \|`	<th>	Pipes define columns
`\|-----\|-----\|`	`Separator`	`\| --- \| --- \|`	divider	Required after header row
`\| :--- \|`	`Left align`	`\| :--- \|`	left	Colon on left side
`\| ---: \|`	`Right align`	`\| ---: \|`	right	Colon on right side
`\| :---: \|`	`Center align`	`\| :---: \|`	center	Colons on both sides

Horizontal Rules

Syntax	Shorthand	Example	Rendered	Notes
`---`	`Rule (hyphens)`	`---`	<hr>	Three or more hyphens
`***`	`Rule (asterisks)`	`***`	<hr>	Three or more asterisks
`___`	`Rule (underscores)`	`___`	<hr>	Three or more underscores

Escaping

Syntax	Shorthand	Example	Rendered	Notes
`\*`	`Escape char`	`\literal\`	literal	Backslash escapes: \\ ` * _ { } [ ] ( ) # + - . !

Часто задаваемые вопросы

Markdown — это облегчённый язык разметки, созданный Джоном Грубером в 2004 году, который позволяет писать обычный текст, автоматически преобразуемый в HTML. Строка, начинающаяся с #, становится <h1>, **текст** — жирным, а *текст* — курсивом. Поскольку Markdown хорошо читается как обычный текст и преобразуется в чистый HTML, он стал стандартом для файлов README, документации, форумов вроде Reddit и Stack Overflow, а также приложений для ведения заметок. Большинство современных редакторов и платформ поддерживают его «из коробки».

CommonMark — это строгая, однозначная спецификация Markdown, устраняющая многолетние противоречия между различными реализациями. GitHub Flavored Markdown (GFM) расширяет CommonMark задачами-чекбоксами (- [ ] / - [x]), таблицами, зачёркнутым текстом (~~текст~~) и автоссылками. Большинство платформ для разработчиков — GitHub, GitLab, VS Code — используют GFM. Для чисто документационных сайтов CommonMark является более надёжной базой.

Пустая строка создаёт новый абзац. Чтобы перенести строку внутри абзаца без создания нового, завершите строку двумя или более пробелами перед нажатием Enter. Кроме того, некоторые парсеры принимают обратную косую черту \ в конце строки. Наиболее надёжный кроссплатформенный способ — использовать пустую строку для разделения абзацев и HTML-тег <br> для переноса внутри абзаца.

Да — большинство парсеров Markdown допускают встроенный HTML. Блочные HTML-элементы, такие как <div>, <table> или <blockquote>, должны быть окружены пустыми строками и не должны иметь отступов. Строчные HTML-элементы — <kbd>, <sup>, <br> и <span> — можно использовать свободно. HTML удобен для функций, которых нет в Markdown: цветной текст, горячие клавиши, нижние индексы или пользовательские атрибуты.