Синтаксис Markdown

Полный справочник по синтаксису Markdown для аккуратно оформленных документов

Markdown — облегчённый язык разметки: с помощью нескольких простых символов текст превращается в заголовки, списки и таблицы. Правила простые и быстро запоминаются, поэтому Markdown удобен для заметок, учебных работ и технической документации. В этом справочнике собран весь синтаксис, который поддерживает MarkPDF.

Заголовки

Заголовки создаются символом #; количество # задаёт уровень — от H1 до H6

Markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Результат
<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>
<h6>Heading 6</h6>

Абзацы и переносы строк

Разделяйте абзацы пустой строкой. Чтобы перенести строку внутри абзаца, поставьте в конце строки два пробела и нажмите Enter

Markdown
This is paragraph one.

This is paragraph two.

Line one with two spaces at end  
Line two (soft break)
Результат
<p>This is paragraph one.</p>
<p>This is paragraph two.</p>
<p>Line one with two spaces at end<br>
Line two (soft break)</p>

Выделение

Звёздочки или подчёркивания вокруг текста делают его жирным или курсивом

Markdown
*Italic* or _italic_
**Bold** or __bold__
***Bold and italic***
~~Strikethrough~~
Результат
<em>Italic</em>
<strong>Bold</strong>
<strong><em>Bold and italic</em></strong>
<del>Strikethrough</del>

Списки

Нумерованные, маркированные и вложенные списки

Markdown
Unordered list:
- Item 1
- Item 2
  - Nested item
  - Another nested

Ordered list:
1. First
2. Second
3. Third
Результат
<ul>
<li>Item 1</li>
<li>Item 2
  <ul>
  <li>Nested item</li>
  <li>Another nested</li>
  </ul>
</li>
</ul>
<ol>
<li>First</li>
<li>Second</li>
<li>Third</li>
</ol>

Код

Одна обратная кавычка — для кода в строке, три — для блока кода

Markdown
Inline `code` in text.

```javascript
function hello() {
  console.log("Hello!");
}
```
Результат
<code>code</code>
<pre><code class="language-javascript">
function hello() {
  console.log("Hello!");
}
</code></pre>

Таблицы

Таблицы рисуются вертикальными чертами и дефисами, можно задать выравнивание

Markdown
| Header 1 | Header 2 | Header 3 |
|----------|:--------:|---------:|
| Left     | Center   | Right    |
| Cell     | Cell     | Cell     |
Результат
<table>
<thead><tr>
<th>Header 1</th>
<th align="center">Header 2</th>
<th align="right">Header 3</th>
</tr></thead>
<tbody>
<tr><td>Left</td><td>Center</td><td>Right</td></tr>
<tr><td>Cell</td><td>Cell</td><td>Cell</td></tr>
</tbody>
</table>

Цитаты

Символ > создаёт цитату, цитаты можно вкладывать друг в друга

Markdown
> This is a blockquote.
> It can span multiple lines.
>
> > Nested blockquote
Результат
<blockquote>
<p>This is a blockquote.
It can span multiple lines.</p>
<blockquote><p>Nested blockquote</p></blockquote>
</blockquote>

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

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

Markdown
---
***
___
Результат
<hr>

Экранирование

Обратная косая черта перед специальным символом выводит его как обычный текст

Markdown
\*Not italic\*
\# Not a heading
\[Not a link\]
Результат
*Not italic*
# Not a heading
[Not a link]