Поговорим про Markdown?

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

Но!

Произошло ужасное! Я обнаружил, что каким-то образом не все на планете еще знают, что это такое и как это прекрасно! Ну и вообще дальше в этом канале будет много информации о том как это красивее всего приготовить и упростить жизнь себе и тем, с кем вы работаете.

А о презентациях когда-нибудь потом.

Что такое Markdown?

Че там у Википедии?

Markdown (произносится маркда́ун) — облегчённый язык разметки, созданный с целью написания наиболее читаемого и удобного для правки текста, но пригодного для преобразования в языки для продвинутых публикаций (HTML, Rich Text и других).

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

Почему Markdown?

Просто быдловато переведу вам укороченный двухминутный ответ разработчика иногда полезной утилиты Marked 2:

• Очень простой в изучении. Если можете нарисовать смайлик “:)”, можете и в MD, экспериментируйте!

• Быстрый. Не нужно обставлять все HTML тегами вручную, да и вообще весь воркфлоу выходит быстрее, нежели делать это все в Word и прочих WYSIWYG редакторах, отвечаю.
• Читабельный (посмотрите на скрин выше, все же KPACUBO).
• Переносимый. .md файл можно открыть любым текстовым редактором.
• Легко конвертируемый из всего во все, зацените.
• Подходит всем, кто имеет дело с буквами, при небольших усилиях в настройке вы сэкономите всем кучу времени.

От себя добавлю, что treat docs as a code, версионирование, совместная работа над текстом и прочие ништяки — это путь к успеху

Фрагментированность

Изначальная спецификация языка вышла довольно вялой и не определила строгий синтаксис. А что происходит когда у чего-то нету точной спецификации? Правильно, все начинают выдумывать свой велосипед. Сейчас количество велосипедов достигло отметки 20+, что привело к ситуациям, когда документ на одном ресурсе выглядит по одному, а на другом ну вы поняли.

Если вы таки попали в ситуацию, где используются поблизости две различных реализации Markdown, то есть (ужасный по своей сути, т.к такой инструмент не должен быть в принципе нужен) сервис (не совсем) для проверки вашего документа на совместимость со всеми 20+ реализациями Markdown — Bablemark 2.

Как с этим жить?

Вариантов, что с этим делать несколько:

1. Вы можете выбрать одну из множества реализаций с подходящим для >ваших< задач функционалом, благо там много всего понапридумывали.
2. Выбрать CommonMark. (CommonMark — это спецификация Markdown запедаленная группой любителей заинтересованных в концепции языка. Главная цель CommonMark — поставить окончательную точку и разрешить все неясности связанные с отсутствием четкой спецификации.)
3. Плюнуть на все и пользоваться Sphinx или Asciidoctor или еще ЧЕМ-ТО НЕ ТАКИМ ПОПУЛЯРНЫМ, И МОДНЫМ КАК МАРКДАУН.

Спасибо что дочитали, надеюсь что-то новое вы для себя узнали (хоть будете знать кто такой Аарон Шварц, если вы еще не).

Дальше — больше.

Любите свою работу и хорошего вам дня 😸