О Предпросмотр Markdown

Markdown Preview превращает исходный текст Markdown в читаемый предпросмотр, чтобы проверить заголовки, списки, ссылки, цитаты, таблицы и блоки кода.

Используйте перед отправкой README, фрагмента документации, issue или черновика блога.

Как пользоваться Markdown Preview

Вставьте исходный текст Markdown.
Используйте пример для проверки таблиц GFM, огороженных блоков кода и ссылок.
Проверьте иерархию заголовков, отступы списков и отображение ссылок.

Когда это полезно

Проверить языки в блоках кода README и выравнивание таблиц перед коммитом.
Посмотреть issue на GitHub или заметку о релизе перед публикацией.
Проверить фрагменты документации API на заголовки и вложенные списки.

Синтаксис Markdown и ловушки форматирования

Markdown легкий, но пустые строки, отступы и число обратных кавычек влияют на отображение. GitHub Flavored Markdown добавляет таблицы, списки задач и огороженные блоки кода.

Заголовки используют # и должны идти в логической иерархии.
Вложенные списки зависят от отступов; табы и пробелы вместе часто ломают вёрстку.
Огороженные блоки кода используют три обратные кавычки и могут содержать имя языка.
Текст ссылки должен быть описательным, а не просто «нажмите здесь».

Частые вопросы: Предпросмотр Markdown

Поддерживается GitHub Flavored Markdown?: Основные возможности GFM вроде таблиц, огороженных блоков кода и списков задач можно посмотреть в предпросмотре, но итоговое отображение зависит от целевой платформы.
Почему вложенный список не работает?: Обычно дело в отступах или пустых строках. Дочерние пункты нужно сдвинуть глубже родительских и сохранять один стиль маркеров.
Content отправляется на сервер?: Нет. Отрисовка Markdown выполняется локально в браузере и не отправляется на wetool.site.

Markdown Preview и publishing

Предпросмотр ловит большинство проблем с оформлением, но GitHub, npm, форумы и CMS могут использовать другие расширения Markdown и санитайзеры. Перед публикацией проверьте целевую платформу.

Сравнение диалектов Markdown

Предпросмотр помогает находить проблемы структуры, но диалекты Markdown различаются между платформами.

CommonMark покрывает базовый синтаксис: заголовки, абзацы, списки, цитаты и блоки кода.
GitHub Flavored Markdown добавляет распространённые расширения: таблицы, списки задач, зачёркивание и автоссылки.
Блоги, CMS и сайты документации могут добавлять front matter, якоря заголовков, сноски или формулы.

Безопасная отрисовка и границы публикации

Предпросмотр Markdown не является финальной средой публикации, особенно для HTML, изображений, внешних ссылок и фильтров платформы.

Не считайте недоверенный Markdown безопасным HTML; целевые платформы обычно sanitize необработанный HTML.
Внешние изображения и links после publishing могут раскрыть источники запросов, параметры токена или внутренние адреса.
Перед публикацией README, документации npm или страниц CMS проверьте итоговое отображение на целевой платформе.