Руководство по синтаксису Markdown
Основной синтаксис для форматирования документов
Обзор
Markdown — лёгкий язык разметки для добавления форматирования к обычному тексту. Созданный Джоном Грубером в 2004 году, он стал одним из самых популярных в мире.
Markdown отличается от WYSIWYG-редакторов. В Word вы нажимаете кнопки — и текст меняется. В Markdown вы добавляете синтаксис к тексту, чтобы указать, как должны выглядеть слова и фразы.
Заголовки
Заголовок создаётся решётками (#) перед словом или фразой. Количество решёток задаёт уровень (например, ### Мой заголовок — уровень 3).
Heading level 1
Heading level 2
Heading level 3
Heading level 4
Heading level 5
Heading level 6
Абзацы
Абзацы разделяются пустой строкой между одной или несколькими строками текста.
It lets me write easily.
<p>It lets me write easily.</p>
I really like using Markdown.
It lets me write easily.
Переносы строк
Для переноса строки закончите её двумя или более пробелами и нажмите Enter.
And this is the second line.
And this is the second line.</p>
This is the first line.
And this is the second line.
Выделение
Выделение можно сделать жирным или курсивом.
Жирный
Для жирного текста добавьте две звёздочки (**) или два подчёркивания (__) до и после слова или фразы.
I just love bold text.
I just love bold text.
Курсив
Для курсива добавьте одну звёздочку (*) или одно подчёркивание (_) до и после слова или фразы.
The cat meows.
The cat meows.
Жирный и курсив
Для одновременного жирного и курсива добавьте три звёздочки (***) или три подчёркивания (___) до и после слова или фразы.
This text is really important.
This text is really important.
Цитаты
Чтобы сделать цитату, поставьте > перед абзацем.
Dorothy followed her through many of the beautiful rooms in her castle.
Вложенные цитаты
Цитаты можно вкладывать. Поставьте >> перед абзацем, который нужно вложить.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Списки
Элементы можно оформить нумерованными и маркированными списками.
Нумерованные списки
Нумерованный список: строки с номером и точкой. Номера могут идти не по порядку, но список должен начинаться с 1.
2. Second item
3. Third item
4. Fourth item
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
<li>Fourth item</li>
</ol>
- First item
- Second item
- Third item
- Fourth item
Маркированные списки
Маркированный список: дефис (-), звёздочка (*) или плюс (+) перед каждым элементом.
- Second item
- Third item
- Fourth item
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
<li>Fourth item</li>
</ul>
- First item
- Second item
- Third item
- Fourth item
Код
Чтобы обозначить слово или фразу как код, заключите их в обратные кавычки (`).
At the command prompt, type nano.
Блоки кода
Для блока кода отступите каждую строку не менее чем на 4 пробела или одну табуляцию, либо используйте три обратные кавычки (```) до и после блока.
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}Горизонтальные линии
Горизонтальная линия: три или более звёздочек (***), дефисов (---) или подчёркиваний (___) в отдельной строке.
Ссылки
Ссылка: текст в квадратных скобках (например [Duck Duck Go]), сразу за ними URL в круглых (например (https://duckduckgo.com)).
My favorite search engine is Duck Duck Go.
Добавление подсказок
Для ссылки можно добавить подсказку (title). Она показывается при наведении. Укажите её в кавычках после URL.
My favorite search engine is Duck Duck Go.
Изображения
Для изображения поставьте !, затем в квадратных скобках — альтернативный текст, в круглых — URL или путь. В кавычках после пути можно указать подсказку.
Экранирование символов
Чтобы показать символ, который в Markdown имеет особое значение, поставьте перед ним обратную косую черту (\).
* Without the backslash, this would be a bullet in an unordered list.
Экранируемые символы
Обратная косая черта экранирует следующие символы:
| \ | backslash |
| ` | backtick |
| * | asterisk |
| _ | underscore |
| { } | curly braces |
| [ ] | brackets |
| ( ) | parentheses |
| # | pound sign |
| + | plus sign |
| - | minus sign (hyphen) |
| . | dot |
| ! | exclamation mark |
| | | pipe |
Таблицы
Таблица: не менее трёх дефисов (---) для заголовка каждого столбца и вертикальные черты (|) между столбцами. По краям таблицы | необязательны.
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
Выравнивание
Текст в столбцах можно выровнять по левому краю, правому или по центру, добавив двоеточие (:) слева, справа или с обеих сторон от дефисов в строке заголовка.
| :--- | :---: | ---: |
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |
| По левому краю | По центру | По правому краю |
|---|---|---|
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |