Предпросмотр Markdown
Пишите и предпросматривайте Markdown
Как использовать Предпросмотр Markdown
Пишите и предпросматривайте Markdown Бесплатный онлайн-инструмент, без регистрации, без навязчивой рекламы. Используйте прямо сейчас.
Где используется Markdown?
Markdown — лёгкий язык разметки, созданный в 2004 году Джоном Грубером. Он использует простой синтаксис обычного текста для добавления форматирования — и разработан так, чтобы быть читаемым «как есть» и легко конвертироваться в HTML.
- Техническая документация: README-файлы на GitHub и GitLab пишутся на Markdown. Каждый open source проект использует его для руководств по установке, API-документации и правил для участников. Российские разработчики активно используют GitHub и GitLab в своих проектах.
- Генераторы статических сайтов: Jekyll, Hugo, Gatsby и Eleventy строят сайты из Markdown-файлов — пишешь в Markdown, публикуешь автоматически как HTML.
- Приложения для заметок: Notion, Obsidian, Bear и Typora используют Markdown для заметок с форматированием, совместимых с системами контроля версий.
- Форумы и чаты: Reddit, Stack Overflow, Discord, Slack, а также Telegram-боты поддерживают Markdown для форматирования сообщений — повсеместно применяется в технических онлайн-сообществах.
- Блог-платформы: Ghost, Hashnode и DEV.to используют Markdown как основной формат написания — позволяет авторам сосредоточиться на содержании, не думая об HTML.
Базовый синтаксис: # H1, ## H2, **жирный**, *курсив*, [ссылка](URL), , `код` и ```блок кода```. Таблицы используют вертикальные черты: | Колонка1 | Колонка2 |.
В чём разница между Markdown и HTML?
HTML — настоящий язык, который интерпретируют браузеры. Markdown — более простой синтаксис, автоматически конвертируемый в HTML. '**жирный**' в Markdown становится 'жирный' в HTML. Markdown пишется значительно быстрее и лучше читается как обычный текст, но HTML даёт больший контроль над стилем и структурой.
Какой диалект Markdown использовать?
CommonMark — стандартизированная спецификация. GitHub Flavored Markdown (GFM) добавляет таблицы, зачёркнутый текст, списки задач и подсветку синтаксиса — наиболее широко используется. GFM — выбор для README на GitHub и большинства современных платформ документации.
Может ли Markdown содержать HTML?
Да — большинство Markdown-парсеров допускают HTML inline. Его можно использовать для элементов, не поддерживаемых Markdown: цветной текст, CSS-классы, iframe. Некоторые платформы (GitHub README) удаляют HTML в целях безопасности.
Как добавить таблицу в Markdown?
Используйте вертикальные черты: | Заголовок 1 | Заголовок 2 | в первой строке, затем |---|---| как разделитель и строки данных. Выравнивание управляется двоеточиями: |:---| — по левому краю, |---:| — по правому, |:---:| — по центру.
Что такое frontmatter в Markdown?
Frontmatter — блок YAML в начале Markdown-файла, ограниченный ---. Хранит метаданные: заголовок, дату, автора, теги, описание. Генераторы статических сайтов используют его для построения веб-страниц из текстовых файлов.
Markdown vs reStructuredText vs AsciiDoc vs HTML
Markdown — проще всего и наиболее широко принят: идеален для README, блогов и документации. reStructuredText (RST) мощнее, используется в Python-проектах и Sphinx для сложной технической документации. AsciiDoc наиболее полный — для технических книг с профессиональным выводом в PDF. HTML даёт полный контроль, но многословен и плохо читается как источник. Для большинства задач написания и документации Markdown — правильный выбор.