Введение в Markdown

Что такое Markdown?

Markdown - это язык разметки, используемый для форматирования документов всех типов, созданный Джоном Грубером и Аароном Шварцем в 2004 году, сегодня это один из самых популярных языков среди программистов.

Согласно Википедии:

ПРИМЕЧАНИЕ: язык разметки - это язык, который использует tags или символы для применения стилизации к содержимому. Самыми популярными языками разметки в мире являются HTML, XML и Markdown.

На изображении ниже вы можете увидеть файл, отформатированный с помощью Markdown в текстовом редакторе Sublime Text.

Файл Markdown или MD состоит из простого текста, прост для понимания и не содержит всей этой разметки HTML, загрязняющей содержимое.

ПРИМЕЧАНИЕ: MD - это сокращение от Markdown.

С помощью Markdown вы можете добавить к документу форматирование с помощью разметки символов.

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

ПРИМЕЧАНИЕ: WYSIWYG - это сокращение от What You See Is What You Get . В основном форматирование контента происходит в реальном времени, то есть видно сразу. Чтобы узнать больше, вы можете обратиться к этой статье Википедии.

Например, в Microsoft Word, который является редактором WYSIWYG, форматирование текста происходит при выборе определенного содержимого и нажатии определенной кнопки, комбинации клавиш или некоторого пункта меню.

В Markdown форматирование применяется с использованием таких символов, как знак фунта #, звездочка * и подчеркивание _.

Эти символы используются процессором Markdown, чтобы узнать, какие слова / фразы следует форматировать при преобразовании файла в HTML.

Например, ** Я хочу, чтобы этот текст был полужирным ** и _этот текст курсивом_.

Слишком запутались? Немного упростим.

Когда вы окружаете контент двумя звездочками **, вы выделяете его жирным шрифтом, во втором примере мы используем подчеркивание _, чтобы применить курсив.

Как редактировать файл Markdown

Файл Markdown - это не что иное, как текст, поэтому для этой задачи достаточно любого простого текстового редактора.

Однако интересно принять во внимание:

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

Хорошая новость в том, что:

• Существует несколько приложений Markdown для различных операционных систем, включая Windows, Linux, Android и даже iOS.
• Когда дело доходит до Web, все становится еще лучше, несколько сайтов предлагают бесплатные приложения Markdown для редактирования ваших документов online, и, что лучше всего, многие имеют конвертер в реальном времени, то есть, когда вы вводите приложение, уже конвертирующееся в HTML .

ПРИМЕЧАНИЕ: стоит помнить, что форматирование Markdown чрезвычайно простое, поэтому документ, отформатированный на этом языке, остается читаемым.

Markdown против WYSIWYG

Если редактор WYSIWYG (который предлагает форматирование в реальном времени) чрезвычайно удобен, зачем мне использовать Markdown?

Если я использую редактор WYSIWYG, я могу нажать кнопку и получить желаемое форматирование, почему я собираюсь печатать документ с разметкой Markdown?

Давайте посмотрим на некоторые причины использования Markdown:

• Markdown можно использовать для создания практически любого типа документов, будь то веб-сайты, книги, презентации, e-mails, техническая документация и многое другое.
• A portabilidade do Markdown é excepcional. Por ser um documento de texto simples, esse, pode ser editado em qualquer aplicativo de texto. Se contrastarmos com o Microsoft Word, o formato docx é proprietário e necessita de programa específico para ser aberto, o que não acontece com o md.
• Вам это нравится?
• Независимо от того, какую операционную систему вы используете, Windows, Mac или Android, Markdown совместим.
• Сделайте свой документ доступным даже в случае катастрофы. Ваш любимый текстовый редактор больше не работает? Поддержка закончилась? Программа стала платной? Нет проблем, просто выберите любой другой текстовый редактор и продолжайте редактировать и получать доступ к своему документу, что чрезвычайно важно для таких файлов, как техническая документация, книги и TCC.
• Гигантское сообщество Markdown сделало его доступным на ряде веб-сайтов в качестве стандартного языка для форматирования сообщений. GitHub и Reddit - это примеры известных сайтов, использующих Markdown.
• Большое количество людей уже используют Markdown, поэтому их отформатированные документы будут понимать все больше и больше людей.

Практика

Лучший способ учиться - это практиковаться!

Интересно, что для изучения синтаксиса языка у вас есть редактор Markdown.

Самый быстрый способ начать практиковать Markdown - использовать редакторы online. С приложениями Web вам не нужно ничего скачивать, просто зайдите на сайт и начните редактировать файл md.

StackEdit, Dillinger и Editor.md (Markeditor) - хорошие варианты для начала.

ПРИМЕЧАНИЕ: откройте один из редакторов online на другой вкладке браузера, чтобы обучить синтаксис Markdown в реальном времени.

StackEdit

StackEdit - одно из наиболее полных приложений. В дополнение к редактору он также предоставляет конвертер в реальном времени, который отображает HTML на правой панели.

См. Дополнительную информацию о StackEdit в разделе инструментов.

Dillinger

Dillinger имеет очень простой интерфейс, но предлагает несколько вариантов редактирования документа Markdown. Помимо преобразования в реальном времени, вы также можете экспортировать файл в форматы HTML и PDF.

Для получения дополнительной информации о Dillinger [a1] нажмите здесь.

Editor.md (Markeditor)

Editor.md - это инструмент с открытым исходным кодом, в нем есть преобразователь MD для HTML в реальном времени и кнопки, которые позволяют создавать элемент Markdown одним щелчком мыши.

А потом?

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

В разделе "Инструменты a1]" вы найдете обширный список приложений с инструкциями по их использованию и информацией о совместимости с элементами Markdown.

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

Как конвертировать файл Markdown

Давайте разберемся с процедурой, используемой приложениями Markdown для преобразования вашего файла md в другой формат, обычно HTML или PDF.

Простота Markdown

Как определить файл Markdown? По расширению, правильно? Обычно md или markdown.

Файл Markdown представляет собой простой текст, не имеет форматирования, не является зашифрованным и, тем более, скомпилированным.

ПРИМЕЧАНИЕ: Эта простота позволяет программам анализировать ваш текст на предмет символов, которые идентифицируют элементы Markdown.

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

Как происходит преобразование

Конвертер Markdown использует Parser для сканирования своего содержимого на предмет маркировки, совместимой с Markdown; При нахождении совместимой разметки Parser проверяет, есть ли совпадение в выходном формате, например tag HTML, который производит такое же форматирование.

Ниже вы можете увидеть примерную таблицу соответствия между маркером Markdown и tag HTML.

Обратите внимание, что формат HTML является одним из наиболее часто используемых для преобразования Markdown. Ваш файл, преобразованный в HTML, можно просмотреть в любом браузере Web, таком как Google Chrome, Mozilla Firefox и Microsoft Edge.

На изображении ниже вы можете увидеть упрощенную версию процесса конвертации.

ПРИМЕЧАНИЕ: важно отметить, что в более надежном приложении компоненты могут быть разделены, даже если они могут быть независимыми друг от друга. Редактор, конвертер, парсер и т. Д. Изображение выше - это просто простое представление о том, как происходит процедура.

Подведем итоги преобразования в четыре этапа.

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

Некоторые моменты следует выделить

• Эта процедура может отличаться в зависимости от того, где вы редактируете файл Markdown.
• Когда мы говорим о простом редактировании, то есть с использованием любого универсального редактора, эти шаги более очевидны.
• В случае таких издателей online, как Dillinger, StackEdit и Editor.md, этапы 2, 3 и 4 объединяются непосредственно в графическом интерфейсе этих приложений.

Использование Markdown

Создание контента для Web - самый популярный способ использования Markdown. Не только при создании страниц HTML, но также при создании и редактировании сообщений всех видов, от создания простых комментариев до разработки технической документации.

Вы также можете форматировать списки задач, сообщения e-mails, списки покупок и многое другое.

Ниже вы можете увидеть несколько примеров документов, которые можно создать с помощью Markdown.

Сайты

Джон Грубер и Аарон Шварц разработали Markdown, думая о Internet, поэтому создание контента для Web стало одной из самых привлекательных сторон языка.

Многие приложения, совместимые с Markdown, уже автоматически конвертируют свое содержимое в HTML.

Вы можете создавать полные веб-сайты, используя в качестве основы форматирование Markdown. Если это то, что вы хотите сделать, вам могут помочь такие инструменты, как Jekyll и MkDocs.

Jekyll и MkDocs - это инструменты, которые создают статические веб-сайты из документов Markdown. Знайте, что при создании веб-сайтов интересно, что вы как минимум знакомы с HTML, CSS и даже с управлением версиями файлов с помощью Git.

GitHub Pages предоставляет бесплатный хостинг для вашего статического веб-сайта.

Если вам нужно что-то более надежное, например, менеджер контента, знаменитый CMS, взгляните на Ghost.

Ghost - это бесплатная платформа с открытым исходным кодом для bloggers. Инструмент также имеет встроенный редактор Markdown.

Вы пользуетесь WordPress? Сайты, размещенные на WordPress.com, уже поддерживают Markdown, но вы можете использовать plugin Jetpack для сайтов, находящихся на других серверах хостинга.

Форматировать текст

Простота Markdown обходится без всех ярких опций редактора WYSIWYG, таких как Microsoft Word, но при этом предлагает достаточно форматирования для редактирования ваших документов.

Язык поддерживает полужирный шрифт, курсив и зачеркивание, в дополнение к, конечно, спискам, заголовкам, blockquotes и многому другому.

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

Ниже представлен список приложений для создания / редактирования документов Markdown:

• Windows: ghostwriter или же Markdown Monster
• Linux: ReText или же ghostwriter
• Mac: MacDown, iA Writer или же Marked
• Web: Dillinger или же StackEdit
• iOS / Android: iA Writer

Примечания

Markdown - идеальный язык для заметок.

Вот список приложений, совместимых с Markdown.

• Notable: выделяется своей совместимостью с несколькими платформами.
• Bear: мы вошли на территорию Apple, Bear совместим с Mac и iOS, по умолчанию не использует Markdown, но вы можете активировать его. Bear очень похож на Evernote.
• Simplenote: это бесплатно, это просто и хранит заметки. Доступно на всех платформах.
• Boostnote: больше ориентирован на программистов, помимо наличия открытого исходного кода.

А Evernote? OneNote? Кто-нибудь...?

Так что, это...

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

В случае Evernote вы можете использовать Markdown Here или Marxico.

ПРИМЕЧАНИЕ: Markdown Here - это расширение для вашего браузера, которое позволяет вам создавать emails, используя синтаксис Markdown. Вы можете использовать это же расширение на сайте Evernote.

Книги

Что вы имеете в виду при написании книг с помощью Markdown?

Правильно, такие службы, как Leanpub, используют файлы Markdown в качестве основы, преобразование выполняется для EPUB, MOBI и PDF.

Не очень любите электронные книги?

С файлом созданной вами электронной книги вы можете загрузить его в другие службы, такие как Kindle Direct Publishing, и создавать физические копии.

Презентации slides

Да, вы правильно прочитали, вы можете создавать презентации из slides, используя Markdown.

Remark, Cleaver и Landslide - это инструменты, которые генерируют презентации slides прямо в вашем браузере, все они используют файлы md в качестве основы.

Предпочитаете использовать приложения? В macOS вы можете ссылаться на Marked или Deckset. В Windows мы можем преобразовать Markdown в slides, используя Pandoc.

Создание презентаций с использованием разметки Markdown может показаться пустой тратой времени, однако, немного попрактиковавшись, вы обнаружите, что это намного проще и быстрее, чем использование таких инструментов, как PowerPoint или Keynote.

E-mails

Большинство провайдеров e-mail предоставляют редактор WYSIWYG, интегрированный в интерфейс, но давайте посмотрим правде в глаза, многие оставляют желать лучшего, с одной стороны, много сложностей, с другой - отсутствуют параметры форматирования.

И сейчас?

Markdown Here - решение для этих случаев. Расширение для вашего браузера, которое позволяет вам писать свой e-mails, используя форматирование Markdown.

Это бесплатно?

Да, Markdown Here бесплатен, имеет открытый исходный код и мгновенно конвертирует Markdown в HTML.

Техническая документация

Markdown и техническая документация идут рука об руку. Бесчисленные компании используют файлы квугвтовзл для хранения своей документации.

GitHub перенесли свои документы на Markdown с помощью инструмента Jekyll. Кроме того, один из самых известных архивов в мире, README.md из GitHub, состоит из Markdown.

ПРИМЕЧАНИЕ: GitHub использует небольшой вариант Markdown, называемый GitHub-flavored Markdown.

При создании технической документации вам могут помочь следующие инструменты:

• Jekyll: Создает документацию из файлов Markdown, это выбор GitHub Pages.
• MkDocs: Просто, быстро и удобно. Основа документации - файлы .md, в конфигурации используются файлы YAML.
• Docusaurus: Генератор статических сайтов, один из лучших инструментов для создания документов. Docusaurus был разработан Facebook, поддерживает управление версиями, поиск документов и даже переводы.
• Read The Docs: Создает сайты документации на основе файлов Markdown.
• VuePress: По названию вы понимаете, что это как-то связано с Vue, так как VuePress - это генератор статических веб-сайтов, предназначенный для написания технической документации.

Ароматы Markdown

Представьте себе все разные диалекты, существующие в одном языке, сленг, произношения, акценты. Даже носителям языка иногда бывает сложно понять некоторые вещи.

Что ж, как и в случае с языками, реализации Markdown в разных программах также могут отличаться, даже если разница незначительна, она все равно может вызвать путаницу.

Варианты Markdown называются Flavors, например, GitHub использует немного более надежную версию Markdown, называемую GitHub-flavored Markdown или GFM.

Некоторые приложения используют только базовый синтаксис, другие используют комбинацию базового синтаксиса и расширенного синтаксиса, и, наконец, есть приложения, которые время от времени реализуют элементы обоих.

Что делать?

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

В конце концов, лучший вариант - использовать программу, которая предлагает максимально возможную совместимость, например Dillinger или StackEdit.

Некоторые примеры ароматов Markdown: GFM (GitHub-flavored Markdown); MultiMarkdown; Markdown Extra, Kramdown.

Вывод

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

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