Небольшая шпаргалка по использованию языка разметки Markdown, точнее его улучшенного синтаксиса Github-Flavored Markdown (далее GFM).
Отличий немного, ознакомиться можно на
Форматирование текста
Это жирный текст и это жирный текст.
Это **жирный** текст и это __жирный текст__.
Это наклонный текст и это тоже наклонный текст.
А это *наклонный* текст и это тоже _наклонный_ текст.
А это жирный, внутри которого наклонный текст.
А это **жирный внутри, которого _наклонный_** текст.
Ещё пример одновременно жирного и наклонного текста.
***Ещё пример одновременно жирного и наклонного текста.***
Чтобы зачеркнуть текст нужно использовать по две тильды ~
до и после текста (только в GFM).
Чтобы ~~зачеркнуть текст~~, нужно использовать по две тильды ~ до и после текста.
Заголовки
Заголовки размечаются символом решетки в начале строки. Количество решеток соответсвует уровню заголовка.
# Заголовок первого уровня
## Заголовок h2
### Заголовок h3
#### Заголовок h4
##### Заголовок h5
###### Заголовок h6
Неупорядоченные списки
Для разметки используются любые из символов -
, +
, *
.
- элемент 1
- элемент 2
- элемент ...
- элемент 1
- элемент 2
- элемент …
Вложенные пункты отделяются четырьмя пробелами.
* элемент 1
* элемент 2
* вложенный элемент 2.1
* вложенный элемент 2.2
* элемент ...
- элемент 1
- элемент 2
- элемент 2.1
- элемент 2.2
- элемент …
Упорядоченные списки
1. элемент
2. элемент
1. вложенный
2. вложенный
3. элемент
- элемент
- элемент
- вложенный
- вложенный
- элемент
На самом деле нумерация тут не важна, главное чтобы перед элементом списка стояла любая цифра с точкой.
1. элемент 1
1. элемент 2
1. элемент 3
1. элемент 4
Список из абзацев
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
- Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
- Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
* Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
* Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
* Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
Цитаты
Для разметки используется символ >
.
> Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.
Исходный код
В оригинальном Markdown код размечается 4 пробелами в начале каждой строки.
В GFM – по три апострофа до и после блока с кодом.
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>title</title>
</head>
<body>
<p>content</p>
</body>
</html>
```
Инлайн код
Код внтури абзаца заключатся в апострофы. Пример: <html class="some-class">
.
Код внтури абзаца заключатся в апострофы. Пример: `<html class="some-class">`.
Если внутри кода есть апостроф, код нужно заключить в двойные апострофы: There is a literal backtick (`) here.
Если внутри кода есть апостроф, то код надо обрамить двойными апострофами: ``There is a literal backtick (`) here.``
Горизонтальная черта
Создается тремя звездочками ***
или тремя дефисами ---
.
Ссылки
Пример [ссылки с title элементом](https://trofimovdigital.ru "title").
А это [ссылка без title](https://trofimovdigital.ru).
Пример ссылок с разметкой как у сносок.
[Пример][1] [нескольких][2] [ссылок][id] с разметкой как у сносок. [Короткая запись][] без указания id.
[1]: http://trofimovdigital.ru "Optional Title Here"
[2]: http://trofimovdigital.ru
[id]: http://trofimovdigital.ru (Optional Title Here)
[Короткая запись]: http://trofimovdigital.ru
Сноски можно располагать в любом месте документа.
Картинки
Картинка без alt текста.
![](//trofimovdigital.ru/150x150.jpg)
Картинка с альтом и тайтлом.
![Alt text](//trofimovdigital.ru/150x150.jpg "title")
Картинки «сноски» по аналогии с ссылками.
![Картинка][image1]
![Картинка][image2]
![Картинка][image3]
[image1]: //trofimovdigital.ru/250x100.jpg
[image2]: //trofimovdigital.ru/200x100.jpg
[image3]: //trofimovdigital.ru/150x100.jpg
Картинки-ссылки:
[![Alt text](//trofimovdigital.ru/150x100.jpg)](http://trofimovdigital.ru/)
Таблицы
В оригинальном Markdown нет разметки для таблиц, но есть в GitHub Flavored Markdown.
First Header | Second Header
------------- | -------------
Content Cell | Content Cell
Content Cell | Content Cell
Можно управлять выравниванием столбцов используя символ двоеточия. Ещё можно использовать ссылки, наклонный, жирный или зачеркнутый текст.
| Left-Aligned | Center Aligned | Right Aligned |
|:------------- |:---------------:| ---------------------:|
| Content Cell | Content Cell | **bold** |
| Content Cell | Content Cell | ~~strikethrough~~ |
| Content Cell | Content Cell | [link](https://ya.ru) |
Ссылки
На этом всё. Но вы можете поддержать проект. Даже небольшая сумма поможет нам писать больше полезных статей.
Если статья помогла или понравилась, пожалуйста поделитесь ей в соцсетях.