Markdown - гаечный ключ для забивания треугольных болтов

Есть инструменты, которые используются для решения широкого спектра задач и они всегда под рукой. У кого-то это LaTeX и Gnuplot, у кого-то Emacs\Vim, кто-то всему предпочитает Питон, а кто-то Хаскель. Но есть не очень часто всплывающие задачи, требующие узкоспециализированных инструментов. Один из таких гаечных ключей под треугольные болты называется Markdown - упрощённый язык разметки документов.

Зачем этот Markdown нужен?

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

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

• удобно набрасывать структуру документов, например постов в блог, научных статей и конференций. Созданную “рыбу” можно перегнать в LaTeX с помощью pandoc, который выдаёт приличный код.
  
• продумывать активные шаги для проектов, если вы используете GTD для самоорганизации. Здесь используется возможность Markdown просто создавать списки и ссылки на другие документы. Если ваша система GTD сделана в LaTeX, вам снова пригодится pandoc для перегона написанного в markdown обратно в LaTeX.
  
• писать затравки для постов в блог довольно удобно, особенно если использовать визуальные редакторы типа Markable. Полноценные посты писать слишком муторно: раскраска текста невозможна и нет таблиц.
• импорт документов из HTML в LaTeX с сохранением форматирования. Например, у меня был корявый список публикаций на сайте, который делался вручную. Используя Markdown и pandoc, я конвертировал HTML-код в markdown, навёл там порядок и выложил на сайт обратно. Результат не идеален, но намного лучше того, что было.

Но главная киллер-фича Markdown - простое создание списков, в том числе вложенных. Это позволяет продумывать структуру постов и статей, проводить brainstorm и формировать структурированные списки активных шагов для GTD.

Вот как это выглядит в Markdown:

1. Length:
  - what is the shortest lenght
1. Computational performance:
   - Which algorithm type?
       - for Active
       - for Interior
  - What is a practical limit?
1. Impact of Dynamic:
  - What is the additional computational burden?

А вот как тот же самый список выглядит в LaTeX:

  
\begin{enumerate}
\item  Length:
 \begin{itemize}
 \item what is the shortest lenght
 \end{itemize}
\item  Computational performance:
 \begin{itemize}
 \item  Which algorithm type?
  \begin{itemize}
  \item    for Active
  \item    for Interior
  \end{itemize}
 \item  What is a practical limit?
 \end{itemize}
\item  Impact of Dynamic:
 \begin{itemize}
 \item  What is the additional computational burden?
 \end{itemize}
\end{enumerate}
  

Такое простое создание списков делает Markdown идеальным инструментом для Brainstorm в GTD и помогает планировать дальнейшие шаги для проектов. Вообще, можно сделать формочку в Markdown для проекта: цель, активные шаги, материалы - и использовать для конвертации в LaTeX, а там уже вставлять всё в LaTeX-GTD и далее печатать в Circa органайзер.

Идея довольно проста: вы пишете обычный "плоский" текст, и по ходу дела создаёте в нём структуру с помощью очень простых меток. Идея Markdown - быть простым и читабельным для гуманоидов языком разметки - по сути, это упрощённый HTML.

Когда вы пишете в Markdown, форматирование текста остаётся там, где вы его поставили и где вы хотите - кто пытался конвертировать текст из Word в HTML или хоть раз набирал длинный пост в визуальных редакторах типа Blogger, тот хорошо меня поймёт.

Обычный плоский текст дает безумную легкость в редактировании, контроль версий и доступ к документации везде, где есть необходимость. И при помощи pandoc и markdown из всего этого можно генерить практически любые документы и в разных форматах.

Синтаксис Markdown

Очень простой и вполне логичный. Краткое  краткое описание синтаксиса, позаимствованное отсюда:

• Абзацы разделяются пустой строкой
• Два или более пробела на конце строки задают разрыв строки
• Шрифты: **жирный**, _курсив_, `моноширинный`
• Заголовки:  #первый уровень#,    ##второй уровень## 
  
• Списки:
  • неупорядоченные:  -  элемент списка .
  • упорядоченные:      1. элемент списка
• Блок кода - каждая строка начинается с 4 или более пробелов
• Горизонтальная черта: три или более дефиса или звездочки
• Ссылки:
  • встроенные [текст метки](url)
  • в виде сносок
• Изображения:
  • встроенные ![alt text](url)
• Экранирование символов делается с помощью обратной косой черты. Экранироваться должны следующие символы: * _ { } [ ] ( ) # + - . !

На всякий случай приведу его здесь в виде шпаргалки:

Отдельной строкой идёт комментирование в Markdown, которое реализовано криво. Если комментарий короткий (inline), то можно воспользоваться обычным методом комментирования из HTML:

<!-- regular html comment -->

Преимущество такого метода в том, что это будет работать и при конвертировании с помощью pandoc.

В Сети достаточно описаний простенького синтаксиса Markdown, но есть и особо выдающиеся ресурсы:

• исключительный по художественной силе и ценности пост на английском с 30 ссылками на самые разные и полезные ресурсы по Markdown (автор - маковод);
• неплохая вводная статья по синтаксису Markdown от Дениса Евсюкова, но автор считает единственным применением Markdown красноглазие с Jakyll.
• ТуториалЪ Классический, Суровый и Православнъй (на английском).
• а это мало того, что приличное описание Markdown, так ещё и огромное количество ссылок на то, что поддерживает Markdown в той или иной степени.

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

• простенький и минималистский текст
• красиво оформленный в виде вебстраницы
• готовый к печати в виде PDF файла (PDF, 60 Кб)
• ещё один, на английском, плотно оформленный в виде PDF

Для тех, кто не хочет читать - есть видеоурок на Ютубе:


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

Визуальные редакторы для Markdown

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

Редакторы Markdown как приложения

Новомодные облачные сервисы и прочий вебдваноль это, конечно, здорово, но вот случилось страшное и вы остались без соединения с Сетью. И что тогда? А тогда нам поможет старый-добрый десктоп и отдельностоячие приложения.

ReText

Один из немногих работающих редакторов Markdown под Linux это ReText. Так как написан он на QT4 и питоне, приготовьтесь тащить ради этой сопливой поделки размером в 100Кб кучу библиотек Qt4:

# apt-get install python-qt4 ... The following NEW packages will be installed: libqt4-help libqt4-scripttools python-qt4 python-sip 0 upgraded, 4 newly installed, 0 to remove and 184 not upgraded. Need to get 5,728 kB of archives. After this operation, 21.7 MB of additional disk space will be used. Do you want to continue [Y/n]?

Вот за что автор этих строк не любит все эти поделки на питоне: маленькая программа на 100 кб, тянет за собой библиотек на 22 Мб. Тем не менее, визуальный редактор ReText имеет место быть и даже работает:

По сути не представляет собой ничего особенного - просто двухпанельник с минимумом функций. Если вы не хотите тащить половину Qt4, то ReText легко заменяется онлайн-редакторами, часто имеющими куда более внушительную функциональность.

Qute

Ещё один редактор, заслуживающий внимания - Qute. Он хорош тем, что обещает ещё и поддержку LaTeX. Для редактирования кода нужно нажать на абзац с текстом:

Приложение находится в очень ранней стадии разработки, но уже есть версия для Linux. Более того, есть и Android-приложение.  

Поддержка Markdown текстовыми редакторами

Если кто-то начнёт вам заливать про то, что Markdown поддерживается везде и всюду - это враньё слишком оптимистично. Кроме Vim и Emacs, подсветки синтаксиса по умолчанию нет ни в Kate, ни в Gedit, но есть, например, в Submile Text 2. Eё можно воткнуть, но сторонними плагинами - например, в Kate можно сделать так:

Installation is simple - copy the markdown.xml file to your ~/.kde/share/apps/katepart/syntax/ directory.

That’s it. Then, when you open a file with extensions of *.text, *.md, *.mmd, you’ll get Markdown-colored syntax editing!

Get the download code for the XML file (it’s dual-licensed under both GPL and BSD licenses).

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

Онлайн-редакторы Markdown

Те, кто всё ещё пользуется устаревшими текстовыми редакторами вынуждены прикручивать раскраску синтаксиса Markdown самостоятельно. Но у нас же 21 век на дворе, с вебдванолем и веб-сервисами, и нам хочется онлайн визуального редактора. Их есть у нас:

• Markable, пожалуй, самый допиленный и вебдванольный. Умеет сохранять файлы (после регистрации), импортировать из Dropbox и Evernote, сохранять в Dropbox, и постить в Tumblr. Есть поддержка клавиатурных сокращений и переключение вида (одна\две панели). Выбор редакции :-)
  
  
  
  
  
  
• Онлайн редактор от Jon Combe славится очень быстрой отрисовкой и возможностью переключать вид редактора в окне броузера (только код, две вертикальные или две горизонтальные панели), умеет автосохранять текст.
  
  
  
  
  
• Online markdown editor от Werner Robitza: выглядит как альфа-версия Блоггеровского визуального редактора, хотя работает кривовато. Ни сохранения, ни экспорта - просто двухпанельный редактор с кнопками, которые работают не всегда. 

• Dillinger: две панели, убогий фон "тетрадный лист", тормозная отрисовка, но есть возможность экспорта в GitHub и Dropbox, отображение номеров строк, и возможность экспорта HTML.
• Instantmark ещё один простенький двухпанельник, но имеет возможность экспорта файла в форматах Markdowm и HTML (их можно скачать).
• Походный редактор Markdowm: единственная полезная возможность, кроме стандартных кнопок и двух панелей - вкладка с синтаксисом.
• Ещё в качестве онлайн редактора Markdown можно посмотреть на prose - из плюсов интеграция с GitHub и минималистский дизайн.

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

Блогодвижки и Вебсервисы на Markdown

Если Markdown весь из себя такой прекрасный, то где же блогоплатформы его использующие? А нет их Очень мало, так как блог на голом Markdown неудобен (нет тегов, комментариев, сайдбара, приличных тем) и выглядит как привет из 90х. Тем не менее, кое-что можно раскопать.

Сколько-нибудь вебсервисы, поддерживающие Markdown

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

• posterous: поддерживает Markdown, но он продался зачем-то Твиттеру и со дня на день закроется.
• Tumblr: переваривает Markdown разметку, но это одна из самых чудовищных реализаций микроблогов.
• Wordpress поддерживает Markdown разметку через специальный плагин.

Это более или менее продуманные решения, но если нам хочется личного творчества, то...

Связки Markdown + Dropbox

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

• Calepin: Сервис блогов без тем, без тегов, без виджетов, без кастомизации, и с убогим оформлением. И за деньги (в перспективе, см. FAQ).
• scriptogr.am: пожалуй, наименее красноглазое решение, есть оформление лучше, и есть поддержка CSS. Более того, там обещают такую киллер-фичу, как метки для постов.

 Но настоящие мужики ведь не ищут лёгких путей, и поэтому...

Hakyll/Jekyll + Markdown + GitHub = недоблогодвижок

Если у кого-то появилась идея "а я сейчас сделаю клёвый движок на маркдауне и буду писать на нём посты в мегаблог" - подумайте ещё раз. Вы потратите море времени на это, а в результате получите убогий недодвижок и посты (если у вас останутся силы их писать) с примитивным оформлением.

Примеров реализации подобных затей, более или менее удачных, хватает с избытком, и немногие тянут на прилично выглядящий standalone блог, хотя есть и исключения [сайт на Jekyll,  www.juev.ru]:

Зато бороться с хостингом, Jekyll/Hakyll и гитхабом можно до полной потери пульса. Для чего-то более или менее достойного, типа подсветки синтаксиса, выделения цветом и нормальных рисунков с подписями вы вернётесь к WYSIWYG, в котором это делается реально проще.

Здесь хотелось бы напомнить товарищам борзописцам, что блог ценен контентом, а не движком. Можно красноглазить с Markdown сколько угодно и истово боротья за правильный и сакрально чистый HTML. Но на то, как ужасно выглядит код, выданный WYSIWYG-редактором, плевать 99.999% процентам читателей и поисковых систем: люди и роботы ходят на сайты за контентом.

Использование Jekyll и Hakyll для блогодвижков может быть оправдано следующими соображениями:

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

Стоит ли это всё дополнительных усилий, каждый решает сам.

Вики и другие вебсервисы с поддержкой Markdown

Далее я оставлю небольшой список потенциально рабочих решений в виде вики, сайтогенераторов и других исчадий софтостроения:

• Dotclear - достаточно законченное решение для блогодвижка с поддержкой Markdown. Написано на глобальном и надёжном PHP.
• судя по описанию, генератор статических сайтов с поддержкой markdown (под Windows)
• нечто под звучным названием obtvse, выдающее себя за минималистский блогодвижок-генератор статических HTML страничек. Собирает пыль на гитхабе, можно попробовать вдохнуть в него жизнь.
• Sputnik - сравнительно богатая возможностями Wiki с прямой поддержкой Markdown, написанная на Lua. 

Ссылки и информация к размышлению

Много ссылок приведено в тексте, и это в самом деле удобнее делать с помощью Markdown. Корявая поддержка таблиц в Markdown и особенно отсутствие цвета сильно огорчают автора, который привык выделять цветом всё, что ни попадя по поводу и без. Но составление вложенных списков для Еженедельного Обзора в GTD это, пожалуй, убойная возможность Markdown, ради которой можно потратить время на его освоение.