Как пользоваться
- Введите Markdown в редакторе или нажмите «Попробовать пример», чтобы загрузить документ с таблицами и списком задач.
- Предпросмотр обновляется по мере ввода. Переключитесь на «Исходный код HTML», чтобы увидеть созданную разметку.
- Включите или отключите GitHub Flavored Markdown и переносы строк, чтобы настроить отображение текста в соответствии с местом публикации.
- Скопируйте HTML в CMS или письмо либо скачайте результат в формате .html или .md.
Как это работает
Markdown преобразуется с помощью marked — широко используемого парсера с открытым исходным кодом, который соответствует спецификации CommonMark и, если включена опция GFM, поддерживает GitHub Flavored Markdown: таблицы с разделителями | и выравниванием столбцов, списки задач, ~~зачёркивание~~ и автоматическое преобразование URL в ссылки. Сноски, математические формулы и диаграммы Mermaid не входят в эти спецификации и отображаются как обычный текст.
В Markdown может содержаться необработанный HTML; как и большинство Markdown-рендереров, этот инструмент передаёт его без изменений. Чтобы обеспечить безопасность, предпросмотр не вставляется непосредственно на эту страницу. Он отображается во фрейме с песочницей, которому запрещено запускать скрипты, отправлять формы, открывать всплывающие окна и получать доступ к этому сайту. Политика безопасности содержимого также блокирует скрипты, внешние таблицы стилей, шрифты и фреймы. Тег <script> или атрибут onclick в Markdown отображается в исходном коде HTML, но не выполняется. Ссылки в предпросмотре видны, но не открываются; чтобы перейти по ссылке, скопируйте URL.
Для предпросмотра используется нейтральная таблица стилей, похожая на те, что применяются в популярных рендерерах README; на вашем сайте или GitHub тот же HTML может выглядеть иначе. Скопированный HTML — это фрагмент без стилей; в загруженный файл .html добавляется простая таблица стилей, чтобы он выглядел как предпросмотр. Загруженный или скопированный HTML не очищается от потенциально опасного кода, поэтому содержащиеся в нём скрипты будут выполняться везде, куда вы его вставите или где откроете.
Примеры
Проверка README перед отправкой
Вставьте README.md, чтобы проверить выравнивание столбцов таблицы, отображение списка задач в виде флажков и правильное оформление блоков кода перед отправкой файла на GitHub.
Подготовка текста для CMS с поддержкой HTML
Подготовьте запись в блоге в Markdown, затем нажмите «Копировать HTML» и вставьте разметку <h2>, <p> и <ul> в HTML-редактор CMS.
Переносы строк как в чате
В тексте из чата строки разделены одиночными переносами строк. Включите параметр «Считать одиночные переносы строк тегом <br>», чтобы строки не объединялись в один абзац.
Часто задаваемые вопросы
Безопасно ли вставлять Markdown из неизвестного источника?
Да, для предпросмотра. Отображённый HTML показывается во фрейме с песочницей, где скрипты отключены, поэтому даже тег <script> или обработчик события в тексте здесь ничего не сделает. Будьте осторожны, вставляя экспортированный HTML: он не очищается от потенциально опасного кода.
Почему изображения не отображаются?
По умолчанию изображения с других сайтов блокируются, чтобы предпросмотр не отправлял сетевые запросы. Включите параметр «Загружать изображения с других сайтов», чтобы показывать их. Относительные пути, например ./docs/screenshot.png, не работают, потому что соответствующих файлов здесь нет.
Поддерживаются ли сноски, формулы и диаграммы?
Нет. Поддерживаются CommonMark и GitHub Flavored Markdown (таблицы, списки задач, зачёркивание, автоматические ссылки). Сноски, математические формулы LaTeX и диаграммы Mermaid — это расширения, которые в предпросмотре отображаются как обычный текст.
Почему одиночный перенос строки не начинает новую строку?
В стандартном Markdown одиночный перенос строки внутри абзаца считается пробелом. Добавьте в конец строки два пробела, оставьте пустую строку или включите параметр «Считать одиночные переносы строк тегом <br>».
Конфиденциальность
Markdown преобразуется в вашем браузере и не загружается на сервер и не сохраняется. Предпросмотр не загружает данные из интернета, если только вы не разрешите загружать изображения с других сайтов; в этом случае запросы изображений отправляются напрямую на их серверы.