Markdown: Руководство по простому языку разметки

Когда мы читаем тексты — будь то онлайн, газета или печатная книга — мы ожидаем определенного формата. Особо важные слова выделяются жирным шрифтом, заголовок выделяется из остального теста, а структурированный список делает текст более понятным. Мы считаем такое форматирование очевидным — и когда мы сами пишем текст на компьютере, мы обычно можем сделать это без проблем: от регулировки размера шрифта и добавления буллитов до выделения слов жирным шрифтом. Любая программа обработки текстов предлагает пользователям широкий выбор вариантов оформления текста.

Но это отнюдь не является само собой разумеющимся. Как правило, в таких ситуациях вы выделяете текст, а программа отображает его так, как вы хотите. На самом деле в Word и подобных программах вы не можете увидеть сам исходный текст, включая элементы разметки (маркеры). А если бы и увидели, то, скорее всего, не знали бы, что с ним делать: Этот код вряд ли может быть прочитан людьми.

Такие языки, как HTML или LaTeX, можно написать с помощью любого текстового редактора, но людям нелегко их расшифровать. Упрощенный язык разметки Markdown стремится изменить именно это. Он стремится к лучшему из двух миров: быть понятным как для людей, так и для машин. Markdown использует самоочевидные элементы для форматирования текста. Это означает, что текст относительно легко читается людьми.

Как и HTML или LaTeX, Markdown — это язык разметки. Однако, в отличие от этих примеров, Markdown стремится быть максимально простым для чтения. Каждый элемент разметки тесно связан с реальным значением, а не является абстрактным. Это легче всего показать на примере: Если вы хотите выделить слово жирным шрифтом в HTML, вы можете использовать теги ‘<b>’ или ‘<strong>’.

Если вы пишете документ в LaTeX, используйте элемент textbf (в режиме непрерывного текста).

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

С одной стороны, такой вариант легче читать, поскольку звездочки делают полужирный текст понятным, а с другой стороны, четыре символа можно набрать гораздо быстрее, чем теги. Даже без преобразования (т.е. в обычном тексте) читатель может легко определить, что имеет в виду автор — даже без понимания синтаксиса Markdown.

Это делает Markdown особенно привлекательным для пользователей, которые не имеют опыта работы в сфере информационных технологий или веб-дизайна, но при этом хотят регулярно писать тексты для Интернета: например, блоггеры, работающие с системой управления контентом (CMS). Но даже технически подкованные люди прибегают к Markdown для написания простых текстов. Например, некоторые программисты используют язык Markdown для написания вспомогательных документов (например, файлов readme), которые не конвертируются. Открывает ли пользователь текст в программе просмотра Markdown или читает его в сыром виде, разницы в читабельности почти нет.

Для наиболее известных CMS, таких как WordPress или Joomla, существуют плагины, позволяющие системам понимать Markdown. Многие вики, форумы (например, reddit) и генератор сайтов Jekyll также могут работать с этим упрощенным языком разметки.

Markdown не пытается заменить HTML — его творческие возможности в любом случае слишком ограничены. Разработчики языка рассматривают Markdown как дополнение. В документ Markdown можно вставлять элементы HTML, расширяя тем самым диапазон возможностей относительно базового языка. Однако язык Markdown предназначен в первую очередь для упрощения написания текстов (особенно в Интернете). Когда документы Markdown преобразуются синтаксическим анализатором, создаются документы типа HTML для отображения в браузерах.

Поскольку Markdown стремится быть как можно более простым языком разметки, синтаксис Markdown также практически не требует объяснений. Тем не менее, прежде чем использовать его, необходимо ознакомиться с элементами разметки. Мы собрали для вас самые важные функции.

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

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

~~Этот текст зачеркнут.~~ Этот нет.

Для создания заголовка в Markdown обычно используется знак фунта. Он вставляется через пробел перед соответствующим текстом. Для создания заголовков, расположенных ниже по иерархии и, соответственно, меньших по размеру, добавляются дополнительные знаки фунта. Это позволяет создавать до шести уровней заголовков, как и в HTML.

В качестве альтернативы для обозначения заголовков можно использовать знаки равенства и дефисы. Они вставляются в строку под фактическим заголовком. Этот вариант позволяет создавать заголовки только двух разных размеров. Одного знака на заголовок достаточно, хотя часто можно увидеть несколько последовательных знаков. Это объясняется исключительно визуальными соображениями, поскольку это выглядит так, как будто текст подчеркнут один или два раза.

Язык Markdown работает с жестким переносом строк для отделения абзацев друг от друга. Чтобы создать совершенно новый блок текста (

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

В Markdown кавычки в определенной части текста обозначаются с помощью элемента blockquote. Для этого используется знак «больше, чем» (>). У вас есть возможность либо пометить этим знаком каждую отдельную строку, либо вставить его только в начале абзаца и завершить отступ пустой строкой. В элементе blockquote возможны дополнительные элементы форматирования.

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

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

Markdown также дает вам возможность создавать контрольные списки. Они отображаются с помощью флажка, который можно активировать, нажав на него. Вы также можете добавить флажок при создании списка. Для этого вставьте квадратные скобки и символ X.

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

Это и есть `код`.

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

Чтобы отметить весь блок как исходный код, вы можете использовать либо табуляцию, либо четыре пробела — для каждой строки. Вы можете сделать еще больший отступ от выделенных строк, добавив дополнительные табуляции или пробелы.

Если вы предпочитаете использовать знаки для начала и конца блоков кода, вы также можете пометить соответствующий фрагмент тремя обратными знаками в начале и в конце. Здесь у вас также есть возможность — по крайней мере, во многих редакторах Markdown — автоматически создавать цветовые выделения. Для этого введите язык следующего исходного кода после трех вводных обратных знаков.

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

Если вы хотите включить URL-адрес или адрес электронной почты в обычный текст, большинство редакторов Markdown автоматически создают гиперссылку, на которую можно нажать. Но чтобы убедиться, что это произойдет, вы можете вставить знак «меньше-меньше» и «больше-больше». Однако, чтобы предотвратить эту автоматическую функцию редактора, следует пометить URL как код и снова использовать обратные знаки.

Как и в случае с гиперссылками, изображения также можно добавлять в документ Markdown. Чтобы добавить изображения, начните с восклицательного знака. Затем снова вставьте квадратные скобки, содержащие альтернативный текст для изображения, и круглые скобки с URL-адресом изображения. Затем изображение отображается непосредственно в тексте.

Изображения и гиперссылки также можно комбинировать. Чтобы создать кликабельную ссылку, расположенную за изображением, можно объединить эти две функции. В этом случае изображение становится якорным текстом и, соответственно, помещается в квадратные скобки.

Трубы (|) позволяют рисовать таблицы в Markdown. Каждая ячейка отделяется трубой. Чтобы создать строки заголовков, которые визуально отличаются от остального содержимого, вы выделяете соответствующие ячейки дефисами.

В принципе, не важно, чтобы трубы располагались одна под другой. Это только повышает читабельность при просмотре документа Markdown в его необработанном виде. То же самое относится и к трубам, расположенным сбоку. Они также не имеют значения для процесса компиляции.

Markdown дает вам возможность вставлять сноски. Вы можете написать номер ссылки в тексте и сослаться на сноску в конце страницы — соответствующая строка будет создана автоматически. Номер ссылки также форматируется как гиперссылка. Щелчок по ней ведет непосредственно к соответствующей сноске. Чтобы воспользоваться этой автоматической функцией, необходимо сначала вставить номер ссылки после соответствующего слова. В квадратных скобках сначала пишется циркумфлекс, а затем номер.

Номер, который вы используете (возможны и другие термины), не имеет значения. Как и при создании списков, Markdown автоматически выполняет подсчет за вас. Однако важно, чтобы вы правильно указали ссылку для сноски. Добавьте тот же номер на новую строку с циркумфлексом в скобке, вставьте двоеточие, а затем напишите собственно сноску. Она также может быть полностью отформатирована и занимать несколько строк.

Поскольку Markdown тесно связан с HTML, особого внимания заслуживает символ «и», а также знаки «меньше-меньше» и «больше-больше». Эти знаки используются в HTML для открытия и закрытия тегов (<>) или для работы с сущностями (&). Но если вы хотите использовать эти знаки по их первоначальному назначению, в HTML они должны быть замаскированы: &, < и >. В целом, в Markdown нет причин, по которым вы не можете использовать знаки «как есть». Однако, поскольку у пользователей есть возможность перепутать Markdown с HTML, на практике это сложнее. Парсер понимает, когда вам нужны простые знаки, а когда HTML-код, поэтому вам не нужно решать эту проблему самостоятельно.

Помимо специфических символов, используемых в HTML, Markdown также использует определенные символы в качестве разметки. Когда вы вставляете их, синтаксический анализатор реагирует на них при преобразовании. Это относится к следующим знакам:

• Звездочка: *
• Дефис: —
• Подчеркивание: _
• Круглые скобки: ()
• Квадратные скобки: []
• Фигурные скобки: {}
• Точка: .
• Восклицательный знак: !
• Фунт: #
• Акцентная могила: `
• Обратная косая черта:

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