Что такое Markdown? Полное объяснение языка лёгкой разметки
Быстрый ответ
Markdown — plain-text язык разметки с простыми символами: # для headings, ** для bold, * для italic, - для списков, [text](url) для ссылок. Разработан для читаемости как plain text и конвертации в HTML. Используйте наш бесплатный Markdown to HTML Converter.
Введение
Markdown — лёгкий язык разметки, созданный John Gruber в 2004, использующий plain-text форматирование для структурированных документов. Цель — читаемость —исходный Markdown должен выглядеть как то, что представляет, без визуального clutter HTML-тегов. Markdown — стандарт для README на GitHub, документации, блогпостов и приложений заметок вроде Obsidian и Notion.
Шаг за шагом
-
Изучите основной синтаксис
Заголовки: #H1, ##H2, ###H3. Жирный шрифт: **текст**. Курсив: *текст*. Списки: - позиция или 1. позиция. Ссылки: [текст](url). Изображения: . Код: ``inline`` или ```block```. Блоковые кавычки: > цитата. Горизонтальное правило: ---.
-
Понять философию
Markdown предназначен для чтения в виде обычного текста. Исходный код должен выглядеть примерно так же, как окончательный отрендеренный результат — **жирный** выглядит как жирный, # Заголовок выглядит как заголовок. Это контрастирует с HTML, где <strong>жирный</strong> и <h1>Заголовок</h1> визуально загромождены.
-
Изучите варианты
Оригинальная уценка (спецификация Грубера) минимальна. CommonMark — это стандартизированная, четко определенная версия. GitHub Flavored Markdown (GFM) добавляет таблицы, зачеркивание, списки задач и автоматические ссылки. MDX позволяет встраивать компоненты React в Markdown. Большинство инструментов поддерживают GFM.
-
Преобразовать Markdown в HTML
Markdown преобразуется в HTML для веб-публикации. # Привет становится <h1>Привет</h1>, **жирный** становится <strong>жирным</strong>. Генераторы статических сайтов (Astro, Hugo, Jekyll) конвертируют Markdown во время сборки. Используйте наш конвертер Markdown в HTML для мгновенного преобразования.
Примеры
Заголовок и абзац
Вход: # Название
Абзац.
Выход: <h1>Title</h1>
<p>A paragraph.</p>
Жирный и курсив
Вход: **жирный** и *курсив*
Выход: <strong>bold</strong> and <em>italic</em>
Ссылка и изображение
Вход: [text](https://example.com) and 
Выход: <a href="https://example.com">text</a> and <img src="image.png" alt="alt">
Распространенные проблемы
- Разрывы строк — одна новая строка в Markdown не создает разрыв строки в HTML. Используйте два пробела в конце строки или две новые строки для разрыва абзаца.
- Вложенные списки: отступы имеют значение. Постоянно используйте 2 или 4 пробела для вложенных элементов; их смешивание может нарушить структуру списка.
- Необработанный HTML — большинство парсеров Markdown проходят через необработанный HTML, но некоторые его очищают. Проверьте поведение вашего парсера, если вы встраиваете HTML напрямую.
- Разные варианты — Original Markdown, CommonMark и GFM имеют небольшие различия. Проверьте, какой вариант поддерживает ваша целевая платформа.
Советы
- Используйте Markdown для написания и документирования — его гораздо легче читать и писать, чем HTML.
- GitHub Flavored Markdown (GFM) — наиболее распространенный вариант — он добавляет таблицы, зачеркивание и списки задач.
- Пишите в Markdown и конвертируйте в HTML во время сборки блогов и сайтов документации.
- Используйте наш конвертер Markdown в HTML для мгновенного отображения Markdown в вашем браузере.