Что делает инструмент
Конвертер Markdown в HTML превращает текст Markdown в HTML-разметку, которую можно вставить в CMS, шаблон письма, статическую страницу или куда угодно, где принимают HTML, но не Markdown. Он пригодится, чтобы опубликовать README на сайте, перенести заметки в редактор блога или точно узнать, какие теги даёт фрагмент Markdown.
Результат совпадает с HTML популярных рендереров Markdown: заголовки от <h1> до <h6>, абзацы <p>, списки <ul> и <ol>, блоки <pre><code> с классом language- для подсветки синтаксиса и разметка <table> для таблиц в стиле GitHub.
Как пользоваться
- Введите или вставьте Markdown, загрузите файл
.mdили нажмите Пример. - Выберите нужные опции: GitHub Flavored Markdown, переносы строк как
<br>, ID заголовков для ссылок-якорей, очистка для недоверенного ввода и полный HTML-документ вместо фрагмента. - Скопируйте HTML или скачайте его как файл
.html.
Результат обновляется по мере ввода. Отключите опцию полного документа, если вставляете результат в существующую страницу, и включите её, когда нужен отдельный файл.
Пример
Этот Markdown:
## Install
Run the **installer** and read the [guide](https://example.com).
- Windows
- macOS
превращается в такой HTML:
<h2>Install</h2>
<p>Run the <strong>installer</strong> and read the <a href="https://example.com">guide</a>.</p>
<ul>
<li>Windows</li>
<li>macOS</li>
</ul>
Советы
- По умолчанию сырой HTML внутри Markdown остаётся как есть — так поступает большинство рендереров. Включайте очистку всякий раз, когда Markdown написал кто-то другой.
- С ID заголовков можно ссылаться на раздел по адресу вида
page.html#installи строить оглавление по заголовкам. - Блоки кода сохраняют язык в виде класса, поэтому подсветчики вроде Prism или highlight.js распознают их без дополнительной настройки.
- Чтобы видеть результат рядом, используйте предпросмотр Markdown. Для обратного направления есть конвертер HTML в Markdown.
Частые вопросы
› Какой синтаксис Markdown поддерживается?
Весь CommonMark — заголовки, выделение, ссылки, изображения, списки, цитаты, код и горизонтальные линии. С включённым GitHub Flavored Markdown доступны также таблицы с выравниванием столбцов, списки задач, зачёркивание и автоматические ссылки для голых URL.
› Что делает опция очистки?
Она экранирует весь сырой HTML в Markdown, чтобы он отображался как текст, а не превращался в теги, и удаляет ссылки и изображения с опасной схемой URL, например javascript или vbscript. Включайте её, если Markdown написан пользователями, которым вы не доверяете, например в комментариях или на форуме.
› Как создаются ID заголовков?
Так же, как на GitHub. Текст заголовка переводится в нижний регистр, знаки препинания удаляются, а пробелы заменяются дефисами, поэтому Getting Started получает id getting-started. Повторяющиеся заголовки получают -1, -2 и так далее, так что каждый якорь уникален.
› Зачем нужна опция полного HTML-документа?
Она оборачивает результат в целую страницу с doctype, кодировкой UTF-8, тегом viewport, заголовком title из первого заголовка первого уровня и небольшой удобочитаемой таблицей стилей. Сохраните её как файл .html, и она аккуратно откроется в любом браузере.
› Отправляется ли мой Markdown куда-нибудь?
Нет. Преобразование выполняется в браузере с помощью библиотеки marked, и ничего не загружается на сервер.