Введение в Markdown

Уценка

Markdown - это инструмент преобразования текста в HTML. Сегодня он стал де-факто синонимом класса облегченных языков описания разметки. Он использует синтаксис форматирования обычного текста. Идея Markdown заключалась в том, чтобы сделать написание веб-страниц и особенно записей в блогах таким же простым, как написание электронного письма. На момент ноября 2017 года цель достигнута, и Markdown, а также его производные Asciidoc, Asciidoctor и Asciidoctor-pdf широко используются.

Markdown ориентирован только на простой текст и воздерживается от всех других сложностей, которые можно найти в HTML. Его легко изучить, поскольку он остается простым, поэтому он также быстрее, поскольку используются минимальные символы, что также снижает вероятность ошибки в конце. На рисунке 1 показан базовый документ, показанный в редакторе Markdown Stackedit. Слева вы видите исходный код, а справа - соответствующий вывод HTML. Вы можете заметить, что заголовки просто отмечены числом # в соответствии с уровнем иерархии заголовка.

Преобразование текста

Простой текст можно преобразовать в XHTML (HTML) и многие другие форматы с помощью инструментов командной строки, таких как Markdown или Pandoc. По сути, оба инструмента создают только фрагменты HTML и записывают вывод в стандартный вывод. Pandoc предлагает переключатель «-o имя_файла» для записи вывода HTML в указанный файл. Как видно ниже, выходной файл называется базовым.html и содержит фрагмент HTML - два заголовка и абзац.

$ pandoc -o базовый.html базовый.md $ cat базовый.html 
Как создать пакет Debian
 
Предисловие
 Быть ответственным за машину означает заботиться как об аппаратном обеспечении, так и о программных компонентах. С точки зрения повседневной жизни системного администратора, гораздо лучше устанавливать программное обеспечение в виде пакета программного обеспечения, а не набора исходных файлов. Это снижает затраты на правильное обслуживание системы. $ 

Для создания автономных HTML-документов с полным HTML-заголовком Pandoc принимает ключ «-s» следующим образом:

$ pandoc -o базовый.html -s базовый.md $ cat базовый.html           
Как создать пакет Debian
 
Предисловие
 Быть ответственным за машину означает заботиться как об аппаратном обеспечении, так и о программных компонентах. С точки зрения повседневной жизни системного администратора, гораздо лучше устанавливать программное обеспечение в виде пакета программного обеспечения, а не набора исходных файлов. Это снижает затраты на правильное обслуживание системы.   

Преимущество хранения контента отдельно от визуального отображения заключается в том, что это не испортит внешний вид вашего сайта. Версия 1.0.1, разработанный Джоном Грубером и Аароном Шварцем, был выпущен в декабре 2004 года и доступен как бесплатное программное обеспечение (см. Ссылки в конце этой статьи).

Текстовые элементы

Заголовки

В соответствии с соответствующим уровнем HTML, заголовки пишутся с несколькими символами # следующим образом:

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 

Для H1 и H2 допустимы два альтернативных способа записи:

H1 == H2 -- 

Обратите внимание, что количество знаков равенства или тире должно совпадать с количеством символов в заголовке.

Выделение текста

Для выделения текста поддерживаются следующие элементы:

• курсив: одиночные звездочки или одиночные подчеркивания
  --
  * важные * и _тоже важные_
  --
• жирный текст: двойные звездочки или двойные подчеркивания
  --
  ** важно ** и __также важно__
  --
• зачеркнутый текст: двойные тильды
  --
  ~~ текст ~~
  --

Списки

Markdown поддерживает неупорядоченные и упорядоченные списки. Упорядоченные списки начинаются со звездочки, знака плюс или минус. Упорядоченные списки просто начинаются с цифры. Чтобы создать подсписки, сделайте отступ для элемента списка двумя пробелами (Markdown, StackEdit) или четырьмя пробелами (Pandoc), как показано ниже:

1. фрукты * яблоко * банан 2. напитки + вода + молоко 

Изображений

Самый простой способ - использовать встроенный стиль следующим образом:

![Логотип Debian] (логотип debian.png «Логотип Debian») 

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

Подсветка кода и синтаксиса

Есть два варианта - встроенный код и блоки кода. Встроенный код заключен в три обратных кавычки, например «'print (« Привет, мир!»)« '. Блоки кода также начинаются и заканчиваются тремя обратными кавычками, но на отдельных строках, как показано ниже:

"print (" Привет, мир!”)"

Markdown не поддерживает подсветку синтаксиса, но такие диалекты, как Markdown Here, поддерживают.

Таблицы

Markdown не поддерживает таблицы, но расширения, такие как GFM и Markdown Here, делают.

Цитаты

Цитаты начинаются со знака «>». Цитировать текст становится очень удобно.

> "Ой! абсурдно иметь твердое правило о том, что следует> читать, а что не следует. Более половины современной культуры зависит> от того, что не следует читать.">> Как важно быть серьезным. (Оскар Уайлд) 

Ссылки

Ссылки относятся к другим документам или к разделам в текущем. Стиль написания аналогичен изображениям и состоит из описания ссылки в квадратных скобках и URL-адреса в обычных скобках.

[Я встроенная ссылка] (https: // linuxhint.com) 

Кроме того, вы можете добавить альтернативный текст:

[Я встроенная ссылка с дополнительным текстом] (https: // linuxhint.com «LinuxHint») 

На ссылки можно ссылаться следующим образом:

[LinuxHint] [1]… немного текста… [1]: https: // linuxhint.ком 

Это позволяет вам легко создавать списки ссылок в конце вашего документа, как это часто бывает в научных документах.

Заключение

Markdown довольно прост и необходим всем, кто занимается документацией и регулярно публикует контент. Пользоваться им одно удовольствие.

Рекомендации

• StackEdit, https: // stackedit.io / редактор
• Pandoc, http: // pandoc.org /
• Уценка, https: // daringfireball.нетто / проекты / уценка /
• Шпаргалка по Markdown, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet