Уценка: входы и выходы

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

Если вы не знакомы с этим, позвольте мне рассказать вам об этом сегодня!

Markdown делает фантастическую работу по уходу с дороги.

Markdown делает фантастическую работу по уходу с дороги. Я уверен, что в какой-то момент все подчеркнули текст в простом текстовом документе, окружив фразу звездочкой, * вот так *. Именно так и работает в Markdown! Обеспечение дополнительного акцента (выделение слова) так же просто, как ** удвоение звездочки **.

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

Преимущества должны быть очевидны для всех, кто пробовал писать веб-контент и должен был беспокоиться о его форматировании. <em>text here</em> просто слишком сложно набрать, если вы уже в курсе — не говоря уже о том, как безумие тегов HTML, которые мешают документу, может ухудшить читабельность при проверке документа.

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

Если вы хотите попробовать приведенные ниже примеры, обратитесь к официальному браузерному конвертеру Dingus.

Разметка

Пункты

С помощью Markdown текст автоматически преобразуется в абзацы, где блоки текста разделяются пустой строкой. И не только с помощью нескольких тегов типа WYSIWYG ушедших дней, но и с помощью реальных семантических <p> абзацев. Это почти как черная магия.

Просто становится:

Одна небольшая странность с Markdown — то, как обрабатываются одиночные разрывы строк. Философия Markdown заключается в том, что браузер должен обрабатывать разрывы строк, и никто другой. Итак, следующий текст:

Становится довольно резким

Если вам абсолютно необходимо вставить разрыв строки, предоставляется обходной путь: просто добавьте два пробела в конец предыдущей строки, например, так:

Ряд «вариантов» Markdown может обрабатывать разрывы строк так, как вы ожидаете, но об этом позже.

Заголовки

Начните абзац с # , и этот абзац станет заголовком. Число # обозначает номер уровня заголовка ( <h1> , <h2> и т. Д.)

становится:

Альтернативный синтаксис также предоставляется для <h1> и <h2> , например так:

Цитаты

Одним из основных факторов, влияющих на Markdown, является электронная почта в виде простого текста, и это очевидно, когда вы видите, что кавычки отформатированы точно так же, как и в электронной почте : с префиксом > :

… который преобразуется в:

Код

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

Большие блоки кода могут быть определены простым отступом кода на уровень (по крайней мере, одна вкладка / четыре пробела) — уровень отступа будет удален. Markdown автоматически экранирует все специальные символы внутри блока кода, что означает, что вы можете безопасно просто копировать блоки кода, не экранируя вручную < to < и > до > и т.п.

Списки

Другой верный пример того, как Markdown выглядит естественным образом, — это способ указания списка. Просто начните абзац с * (или + , - ), чтобы создать неупорядоченный список. Используйте номера, 1. , 2. и т. Д. Для упорядоченных списков:

Встроенные текстовые элементы

Мы уже рассмотрели выделенный курсивом и жирным шрифтом текст в начале этой статьи ( * и ** ), однако вы также можете поменять звездочки на подчеркивания, если это больше ваша вещь:

Ссылки удобны и просты в Markdown (если вы можете зафиксировать память, прежде всего квадратные и круглые скобки …):

Чтобы отобразить изображение, поставьте перед кодом ссылки символ ! :

Уценка не мешает вам

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

Markdown также автоматически экранирует символы, такие как &, <и>, в форму сущности HTML. Он даже разумно преобразует обычные комбинации символов в то, что вы действительно имеете в виду.

• Три точки автоматически станут многоточием:…
• Два дефиса станут чертой: —
• Кавычки станут «модными», завитыми версиями самих себя.

Flavors & GitHub Ароматизированная уценка

Существует ряд альтернативных вариантов «Markdown», расширяющих набор правил Markdown по умолчанию. Распространенным расширением является простой разрыв строки, как описано выше. Одним из самых известных ароматов Markdown является GitHub’s Flavored Markdown . Это используется для разметки ввода пользователя везде на своем сайте. Наряду с улучшенной поддержкой разрыва строк и рядом настроек, специфичных для GitHub, моя любимая функция — это их альтернатива ограждению кода, которая также позволяет указывать синтаксис для выделения. Просто окружите блок кода ``` с обеих сторон, включая язык в начале, вот так:

преобразование

Конвертер Tuts + Markdown можно найти здесь .

Официальный конвертер написан на Perl и доступен для скачивания на домашней странице Markdown в Daring Fireball . Также существует несколько других конверторов Markdown для множества разных языков — от C … до Ruby … до JavaScript … до PHP. Полный список реализаций можно найти в Википедии .

Одной из популярных реализаций Ruby является RedCarpet , основанная на библиотеке C Sundown, которая предоставляет очень простой способ настройки вывода сгенерированного HTML для создания собственного «аромата» Markdown.

Недавно я использовал эту библиотеку для создания конвертера Markdown, который принимает GitHub Flavored Markdown (чтобы позволить указывать язык кода для подсветки синтаксиса) и выводит преобразованный HTML в особом стиле, требуемом для сайтов Tuts +. Конвертер Tuts + Markdown можно найти здесь . Если вы когда-либо писали учебник для этого сайта, обязательно используйте его!

Фактически, эта статья была написана в Markdown с использованием популярного редактора Mou Markdown для OSX.