Markdown.md, что?

Привет читатель!

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

Давайте сначала согласимся с 1 утверждением - вы хотя бы 1 раз в жизни видели текст подготовленный с помощью упрощённой разметки - markdown(md). Есть и другой популярный стиль разметки - ReStructuredText (rst), он так же очень сильно распространен как и md. Я не хочу их сравнивать или рассказывать про другие стили, банально потому, что основной синтаксис у всех стилей - одинаковый. Отличия только лишь в дополнительных фичах, можете поискать отличия gihub md от md

Где вы видели md?

Да повсюду, стандарт описан в 2004 году, и широко используется, например:

• в github репозиториях для написания инструкций и статей. При создании своего репозитория на github(gitlab, gitea и прочих), вам обязательно предложат создать файл - readme.md
• https://help.qlik.com/en-US/sense/May2022/Subsystems/Hub/Content/Sense_Hub/LoadData/concatenating-tables-in-data-manager.htm
• https://docs.microsoft.com/ru-ru/power-bi/fundamentals/service-get-started
• https://yandex.ru/support/search/search-results/settings.html
• Atlassin Confluence
• Atlassin Jira
• и так далее

Все предложенное выше - это markdown или rst

Почему упрощенная разметка?

• Это не сложно, - выучить синтасис можно за пару минут, а еще можно распечатать на листе А4 шпаргалку и держать под рукой.
• md-текст написанный в любой операционной системе, в любом редакторе текста - всегда будет выглядеть одинаково везде (если мы рассматриваем только стандартные функции). Точнее не сам текст, а то, во что он превратится при выводе в html-страницах.
• Простой текст позволяет вести его версионность без лишних проблем, ведь например:

*text*превратится в <b>text</b>а отображаться будет так: text

и в html-разметке не будет добавлено никаких div/class и прочего из мира CSS

• вам не нужно держать внутри текста картинку на 1024 килобайта, нужно лишь указать ссылку на то место, где она лежит
• конвертировать .md-файл в pdf-документ можно в пару действий. Я например в VSCode это делаю парой манипуляций на клавиатуре
• есть и другие плюсы, и их не мало, можете поискать сами, для кого то другие особенности будут иметь бОльшее значение чем для меня

Хочу еще!

С вами не поспорить, чего уж.

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

или множество других, подобных. Сейчас, как я думаю, для большинства языков программирования уже созданы все условия для автоматической документации (Привет 1С:Предприятие ! А у тебя есть автодокументирование? :))

Я уверен что для ваших любимых IDE тоже есть модули/компоненты/дополнения, которые так же помогают писать документацию по ходу написания кода. Вот, например python + vscode

Есть специализированные сервисы, которые позволяют делать версионированные справки, то же readthedocs чего стоит, а он не один такой

Наиболее полная документация по md живет тут : https://www.markdownguide.org/getting-started/

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