Инструменты Markdown

Что такое Markdown

Markdown — способ записывать оформленный текст обычными символами: # для заголовков, * или _ для выделения, - для списков, обратные апострофы для кода и вертикальные черты для таблиц. Исходник остается читаемым как простой текст, а программа-рендерер превращает его в HTML. Поэтому Markdown используют в README, на сайтах документации, в вики, приложениях для заметок и мессенджерах. GitHub Flavored Markdown добавляет к исходному синтаксису таблицы, списки задач, зачеркивание и автоматические ссылки. У файлов расширение .md или .markdown.

Типичные задачи

Чаще всего файл нужно просто прочитать. В обычном текстовом редакторе файл .md выглядит как набор служебных символов, а отдельной программы для Markdown на компьютере может не быть. Markdown viewer показывает документ как на GitHub — с оглавлением, подсветкой кода, формулами и диаграммами — и умеет сохранить результат одним HTML-файлом.

Вторая задача — написать текст: README нового проекта, примечания к релизу, статью для блога или документацию. В редакторе Markdown исходник и живой предпросмотр стоят рядом, панель форматирования вставляет жирный текст, ссылки, списки, таблицы и код, черновик хранится в браузере и не пропадет при закрытой вкладке, а готовый документ скачивается как .md, HTML или PDF.

Третья задача — таблицы, самая капризная часть синтаксиса. Таблицу можно собрать в генераторе таблиц Markdown или выровнять готовую в форматировании таблиц. Данные превращаются в таблицу из CSV, TSV, JSON, YAML, Excel и HTML, а обратно — в CSV, Excel, JSON и HTML.

Четвертая задача — перенести текст на другую платформу: конвертировать Markdown в Jira, Confluence, Slack, LaTeX, Word, HTML и другие разметки или обратно из Jira, RST и HTML.

Пятая задача — порядок в файлах: объединить файлы Markdown, разделить Markdown, собрать оглавление, привести текст к единому стилю в форматировании Markdown, посчитать слова в счетчике слов и выгрузить метаданные инструментом front matter в JSON.

Конфиденциальность по умолчанию

Файлы Markdown отрисовываются прямо в браузере: на сервер ничего не загружается, регистрация не нужна. Перед показом HTML очищается, поэтому документ со встроенными скриптами не сможет выполнить код на странице, а диаграммы рисуются в изолированной песочнице. Черновики редактора хранятся в локальном хранилище этого браузера на вашем устройстве, и их можно удалить в любой момент.