Синтаксис Markdown

Markdown — это утилита, позволяющая преобразовывать текст в HTML. Markdown позволяет писать обычный текст, который легко читать и редактировать, а затем преобразовывать в HTML.

Содержание:
Абзацы, заголовки, цитаты в Markdown
Ударение на фразы в Markdown
Списки в Markdown
Ссылки в Markdown
Изображения в Markdown
Код в Markdown

Все примеры из этой статьи и их результаты вы можете посмотреть на GitHub.

Абзацы, заголовки, цитаты в Markdown

Абзацы в Markdown — это просто несколько идущих подряд строк текста. Абзацы разделяются одной или более пустых строк. (Пустая строка — это любая строка, которая выглядит пустой. Строка, содержащая только пробелы и табуляторы считается пустой).

Markdown позволяет использовать два стиля заголовков: Setext и atx. Стиль Setext для заголовков <h1> и <h2> создаётся с помощью «подчёркивания» символами «=» и «-» соответственно. Для создания заголовков в стиле atx вставляются от одного до шести символов «#» в начале строки. Количество символов «#» определяет уровень заголовка.

Цитаты предваряются символами «>».

Markdown:

Результат:

Ударение на фразы в Markdown

Для выделения фраз с помощью HTML-тегов <em></em>  и <strong></strong>  используйте звёздочки и подчёркивания.

Markdown:

Результат:

Списки в Markdown

Неупорядоченные списки создаются с помощью звёздочек, плюсов и знака вычитания. Все эти три способа взаимозаменяемы:

Результат:

Упорядоченные списки создаются с использованием чисел с последующей точкой.

Markdown:

Результат:

Если вы добавите пустые строки между элементами, то вы получите теги <p>  для текстов в элементах. Вы можете создавать элементы списка из нескольких абзацев, для этого делайте отступы в четыре пробела или один символ табуляции:

Результат:

Ссылки в Markdown

Markdown поддерживает два стиля создания ссылок: внутристрочные и в стиле сносок. В обоих стилях используются квадратные скобки для указания текста, который вы хотите использовать в качестве ссылки.

Markdown:

Результат:

Вы также можете указать атрибут title (всплывающую подсказку) внутри скобок:

Результат:

Ссылки в стиле сносок позволяют вам указывать имя ссылки, а саму ссылку определять где-нибудь в другом месте документа:

Результат:

Имена ссылок могут содержать буквы, цифры и пробелы, но они НЕ чувствительны к регистру символов:

Результат:

Изображения в Markdown

Синтаксис вставки изображений в Markdown схож с синтаксисом ссылок.

Встроенная ссылка (title не обязателен):

В стиле сносок:

В обоих случаях результатом будет:

Код в Markdown

В обычном абзаце вы можете вставить тег <code></code>. Для этого вам нужно обернуть текст символом « `» (он расположен на одной кнопке с буквой «ё» на клавиатуре). Символы «&», «<», «>» автоматически преобразуются в коды символов HTML.

Markdown:

Результат:

Чтобы указать целый блок предварительно отформатированного кода, сделайте отступ каждой строки  в четыре пробела или один табулятор. Символы «&», «<» и «>» будут преобразованы в HTML-коды символов автоматически:

Результат:

—