В этой статье
Что такое Markdown?
Markdown — это облегчённый язык разметки, созданный Джоном Грубером в 2004 году. Для форматирования простого текста используется минималистичный синтаксис на основе знаков препинания: заголовки с #, жирный шрифт с **, ссылки с [текст](url) — всё это преобразуется в форматированный HTML. Простота Markdown сделала его универсальным стандартом для документации разработчиков.
Markdown используется повсюду: файлы README на GitHub, ответы на Stack Overflow, сообщения в Slack, страницы Notion, сайты с документацией и блог-платформы. Большинство разработчиков пишут Markdown ежедневно, даже не задумываясь об этом.
Как работает предварительный просмотр Markdown
Предварительный просмотр Markdown в CheckTown в реальном времени преобразует текст в HTML по мере ввода.
- Соответствие CommonMark — рендерит стандартный Markdown согласно спецификации CommonMark
- Расширения GFM — поддерживает GitHub Flavored Markdown, включая таблицы, списки задач и зачёркивание
- Подсветка синтаксиса — блоки кода подсвечиваются для распространённых языков программирования
Попробуйте бесплатно — без регистрации
Просмотр Markdown →Когда использовать предварительный просмотр Markdown
Предварительный просмотр Markdown полезен в любом рабочем процессе, где нужно проверить отображение перед публикацией.
- Файлы README — создавайте и просматривайте файлы README.md перед отправкой в GitHub
- Документация — пишите и просматривайте техническую документацию перед публикацией на сайтах с документацией
- Записи в блог — создавайте записи в Markdown и просматривайте форматированный результат
Частые вопросы
В чём разница между разными вариантами Markdown?
Оригинальная спецификация Markdown оставила многие граничные случаи неопределёнными, что привело к появлению нескольких несовместимых реализаций. CommonMark — это стандартизированная спецификация, устраняющая неоднозначности. GitHub Flavored Markdown (GFM) расширяет CommonMark таблицами, списками задач и автоссылками. Большинство платформ используют либо CommonMark, либо GFM.
Можно ли встроить сырой HTML в Markdown?
Да, большинство процессоров Markdown позволяют встраивать сырые HTML-теги прямо в Markdown-документы. Это удобно для расширенного форматирования, не поддерживаемого синтаксисом Markdown. Однако многие платформы очищают HTML в целях безопасности, поэтому сырой HTML может быть удалён в контекстах пользовательского контента.
Как создать таблицу в Markdown?
Таблицы создаются с помощью символа вертикальной черты и дефисов: | Заголовок 1 | Заголовок 2 | в первой строке, | --- | --- | во второй строке-разделителе, затем строки с данными. Выравнивание столбцов задаётся положением двоеточия в разделителе: :--- — по левому краю, :---: — по центру, ---: — по правому краю.