Markdown Preview
Live Markdown preview
Live Markdown preview Запускается локально в вашем браузере
About the
Предварительный просмотр Markdown отображает ваш Markdown по мере ввода в параллельном представлении, следуя CommonMark, с расширениями GitHub, которые фактически использует большинство людей: таблицы, списки задач, изолированные блоки кода, зачеркивание и автоматические ссылки. Это самый быстрый способ проверить README перед его фиксацией, поскольку различия между тем, как Markdown выглядит в исходном коде, и тем, как он выглядит визуализированным, неочевидны, а синтаксис таблицы, в частности, автоматически дает сбой, когда одна линия или тире неверны. Отрисованный HTML также можно скопировать, если он вам нужен где-то, где не обрабатывается сам Markdown.
Where people use the
- Проверка правильности отображения README перед его отправкой.
- Составление примечаний к выпуску или журнала изменений с просмотром результата в реальном времени.
- Преобразование документа Markdown в HTML для CMS, не принимающей Markdown.
- Просматриваем чужой запрос на включение Markdown и смотрим, как он будет выглядеть.
How to use the
- 1
Вставьте или напишите свой Markdown
Редактор принимает что угодно: от одного абзаца до полноценного документа с заголовками, списками, ссылками и границами кода.
- 2
Посмотрите отрисованную панель
Предварительный просмотр обновляется при каждом нажатии клавиши, поэтому сломанный стол или незакрытый забор отображаются сразу, а не после этапа публикации.
- 3
Исправьте исходник, а не превью
Предварительный просмотр доступен только для чтения. Когда что-то отображается неправильно, причиной почти всегда является отсутствие пустой строки перед списком или заголовком таблицы без строки-разделителя.
- 4
Скопируйте HTML, если он вам нужен.
Переключитесь в представление HTML, чтобы использовать сгенерированную разметку, которая полезна для вставки в CMS, которая ожидает HTML, а не Markdown.
Советы и лучшие практики
- Оставляйте пустую строку до и после каждого элемента блока; самые загадочные ошибки рендеринга — это отсутствие пустой строки.
- Используйте изолированные блоки кода с названием языка, чтобы код выделялся, а не обрабатывался как обычный текст.
- В длинных документах сохраняйте по одному предложению в строке; это делает различия доступными для чтения позже.
Часто задаваемые вопросы
Какая спецификация Markdown используется?
CommonMark в качестве основы, а также расширения Markdown со вкусом GitHub для таблиц, списков задач, изолированного кода и зачеркивания. Эта комбинация охватывает формат README на GitHub, GitLab и большинстве сайтов документации.
Почему моя таблица не отображается?
Таблице необходима строка заголовка, за которой сразу следует строка-разделитель из дефисов и пустая строка перед блоком. В каждом ряду должно быть такое же количество труб, как и в заголовке. Любой из пропавших без вести превращает все это в абзац текста с вертикальной чертой.
Почему пункты моего списка объединились в один абзац?
Markdown нужна пустая строка между абзацем и следующим за ним списком. Без него маркеры списка обрабатываются как обычный текст.
Поддерживает ли он LaTeX или математику?
Нет. Для математического рендеринга требуется отдельная библиотека, такая как KaTeX или MathJax, и другой синтаксис. Выражение со знаком доллара здесь будет отображаться как обычный текст.
Разрешен ли необработанный HTML?
Да, встроенный HTML проходит напрямую, что и GitHub делает. Если вы публикуете результаты где-либо публично, сначала очистите их, поскольку необработанный HTML также используется для внедрения скриптов.
Куда идет мой текст?
Никуда. Анализ и рендеринг выполняются в вашем браузере с помощью библиотеки JavaScript Markdown. Ничего не сохраняется и не передается, поэтому черновик исчезает, когда вы закрываете вкладку, если вы его не скопируете.