Как преобразовать Markdown в HTML-просмотр

Для чего нужен просмотр разметки

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

Текст для запуска необязателен. Если оставить поле пустым или не вводить материал, операция завершится успешно, однако область просмотра останется пустой. Поэтому сначала определите цель проверки: для проверки пустого состояния достаточно не вводить текст, а для оценки оформления потребуется непустой фрагмент.

При непустом вводе успешный результат дополнительно содержит число символов исходного текста. Этот показатель относится к материалу, который был передан, и не описывает размер сформированного HTML-просмотра. Оформление создаётся на основе предусмотренных шаблонных замен, поэтому результат лучше оценивать по конкретным конструкциям, которые вы проверяете.

Пошаговая проверка исходного текста

Подготовьте фрагмент, который хотите проверить. Сохраните в нём исходные обозначения, например знак # перед заголовком, двойные звёздочки вокруг выделенного текста или обратные кавычки вокруг кода. Непустой обычный текст также можно передать, если вы хотите увидеть его базовое отображение.
Вставьте материал в поле инструмента. Отдельно включать обязательный ввод не нужно: поле допускает отсутствие текста. Для содержательной проверки используйте непустой фрагмент, а для проверки пустого состояния оставьте поле без содержимого.
Запустите преобразование доступным элементом управления. Для непустого материала инструмент создаёт форматированный HTML-просмотр с использованием распознаваемых шаблонов. К ним относятся заголовки уровней 1-6, строки табличного вида, горизонтальные линии, цитаты, изображения, ссылки, выделение, зачёркивание, списки, встроенный и многострочный код, а также отдельные варианты переносов строк.
Сопоставьте результат с исходной записью. Проверьте, получил ли заголовок роль заголовка, сохранилось ли выделение и распознаны ли список, ссылка или цитата в ожидаемом виде. Если оформление не появилось, проверьте знаки разметки и попробуйте более простой вариант из предусмотренного набора.
Прочитайте успешный результат после проверки. У непустого материала найдите число символов исходника и сопоставьте его с тем фрагментом, который вы вводили. При пустом вводе ожидайте успешную операцию с пустым просмотром, а не автоматически добавленный текст.

Что означает полученный результат

Просмотр показывает, какие элементы исходной записи были распознаны предусмотренными шаблонами. Например, запись с # может отображаться как заголовок соответствующего уровня, а конструкции для кода, списков, ссылок, цитат и выделения могут получить форматированное представление. Сопоставляйте не только внешний вид, но и роль каждого элемента, которую вы хотели задать в исходнике.

Число символов в успешном результате при непустом вводе описывает оригинальный текст. Его нельзя использовать как размер HTML-просмотра или как подсчёт видимых знаков в отображённом результате. Пустой либо пропущенный ввод тоже приводит к успешной операции, но пустая область просмотра не даёт материала для сравнения с оформленным фрагментом.

Если конструкция выглядит как обычный текст, проверьте порядок специальных знаков и сам тип разметки. Затем замените сложную запись на знакомый поддерживаемый шаблон и выполните проверку снова. Наличие форматированного результата не означает, что распознаётся каждый вариант Markdown: набор доступных замен определяет границы такой проверки.

Практический пример

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

Вставьте в поле две строки: сначала # План, затем **Важный пункт**, после чего запустите преобразование доступным элементом управления. Проверьте раздельное отображение заголовка и выделенного пункта, а также наличие показателя числа символов без привязки к конкретному значению.

Успешный результат содержит форматированный HTML-просмотр: строка с заголовком отображается как заголовок, выделенный фрагмент получает соответствующее оформление, а рядом указывается число символов исходного текста.

Ограничения

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

Частые ошибки

Причина: использована конструкция вне предусмотренного набора или специальные знаки расположены иначе, чем ожидает шаблон. Действие: замените её на поддерживаемый заголовок, список, цитату, ссылку или вариант выделения и повторите проверку.

Частые вопросы

Можно ли запустить Markdown Preview без текста?

Условие зависит от цели проверки: поле можно оставить пустым, и операция завершится успешно. В этом случае просмотр останется пустым, поэтому для оценки оформления передайте непустой материал отдельно.

Что означает число символов в результате?

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

Какие конструкции Markdown можно проверить?

Распознаются шаблоны для кода, заголовков уровней 1-6, строк табличного вида, горизонтальных линий, цитат, изображений, ссылок, выделения, зачёркивания, списков и отдельных переносов строк. Этот набор не подтверждает обработку произвольного синтаксиса Markdown.