Шпаргалка по синтаксису markdown

Что такое markdown?

Markdown — это облегченный язык разметки, который можно использовать для добавления элементов форматирования в документы обычного текста (plaintext). Markdown, созданный Джоном Грубером в 2004 году, в настоящее время является одним из самых популярных языков разметки в мире.

Использование Markdown отличается от использования редактора WYSIWYG (What You See Is What You Get – «что видишь, то и получишь»). В таком приложении, как Microsoft Word, вы нажимаете кнопки для форматирования слов и фраз, и изменения сразу видны. Markdown работает не так. Когда вы создаете файл в формате Markdown, вы добавляете синтаксис Markdown к тексту, чтобы указать, какие слова и фразы должны выглядеть по-разному.

Например, чтобы обозначить заголовок, вы добавляете перед ним символ решётки (например, # Заголовок один). Или, чтобы сделать фразу жирным, вы добавляете две звездочки до и после нее (например, ** этот текст выделен жирным шрифтом ** ). Однако, вам может потребоваться некоторое время, чтобы привыкнуть к синтаксису Markdown в вашем тексте, особенно если вы привыкли к приложениям WYSIWYG.

Базовый синтаксис

По ссылкам можно перейти на подробное описание элементов на сайте www.markdownguide.org (английский)

Элемент	Markdown синтаксис
Заголовок	# H1 ## H2 ### H3
Жирный	**bold text**
Курсив	*italicized text*
Цитата	> blockquote
Нумерованный список	1. First item 2. Second item 3. Third item
Список	- First item - Second item - Third item
Код	`code`
Горизонтальная линия	---
Ссылка	[title](https://www.example.com)
Изображение	

Дополнительный синтаксис

Элемент	Markdown Синтаксис
Таблица	| Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |
Блок кода	``` {   "firstName": "John",   "lastName": "Smith",   "age": 25 } ```
Сноска	Here's a sentence with a footnote. [^1] [^1]: This is the footnote.
Пользовательский ID	### My Great Heading {#custom-id}
Список терминов	term : definition
Зачёркивание	~~The world is flat.~~
Список задач	- [x] Write the press release - [ ] Update the website - [ ] Contact the media