Шпаргалка по Markdown
Шпаргалка по Markdown с поиском и GitHub Flavored Markdown: заголовки, выделение, списки, ссылки, изображения, таблицы, код, списки задач и сворачиваемые блоки, плюс живая песочница.
Загрузка: Шпаргалка по Markdown…
Ваши файлы не покидают устройство
Как пользоваться: Шпаргалка по Markdown
- 1
Откройте «Шпаргалка по Markdown» на этой странице. Инструмент загружается прямо в браузере.
- 2
Добавьте файл, текст или значения и настройте параметры.
- 3
Скопируйте или скачайте результат. Ничего не загружается и не хранится.
Об инструменте
Эта шпаргалка по Markdown показывает весь распространённый синтаксис Markdown с примером и результатом. Найдите нужное, например таблицу, ссылку или жирный текст, и попробуйте любой фрагмент в живой песочнице, чтобы увидеть, как именно он отображается. Здесь есть базовый Markdown и расширения GitHub Flavored, которые используются на GitHub, GitLab, Reddit, Discord и в большинстве инструментов документации.
Базовый синтаксис
| Элемент | Markdown |
|---|---|
| Заголовок | # H1, ## H2, ### H3 |
| Жирный | **жирный** |
| Курсив | *курсив* |
| Ссылка | [текст](https://example.com) |
| Изображение |  |
| Маркированный список | - пункт |
| Нумерованный список | 1. пункт |
| Цитата | > цитата |
| Код в строке | `код` |
| Горизонтальная линия | --- |
GitHub Flavored Markdown
- Таблицы с вертикальными чертами и строкой разделителя, с необязательными двоеточиями для выравнивания.
- Списки задач:
- [ ]сделать,- [x]готово. - Зачёркнутый текст с ~~двумя тильдами~~.
- Ограждённые блоки кода с тремя обратными апострофами и названием языка для подсветки.
- Сворачиваемые блоки с HTML тегами details и summary.
- Автоматические ссылки для обычных URL.
Как пользоваться песочницей
Нажмите на любой пример, чтобы загрузить его в песочницу, отредактируйте Markdown, и предпросмотр мгновенно обновится. Это самый быстрый способ проверить таблицу или вложенный список перед вставкой в README, issue или страницу документации.
Частые ловушки
- Оставляйте пустую строку перед списками, таблицами и блоками кода.
- Одиночный перенос строки в стандартном Markdown не создаёт новую строку; закончите строку двумя пробелами или оставьте пустую строку.
- Экранируйте спецсимволы обратной косой чертой, например \*, чтобы показать звёздочку.
Готовы писать? Используйте редактор Markdown, генератор таблиц или генератор README.
Частые вопросы
Как сделать таблицу в Markdown?
Напишите строку заголовков через вертикальные черты, добавьте строку разделителя из дефисов, затем по строке на каждую запись. Двоеточия в строке разделителя выравнивают столбцы.
Как сделать перенос строки в Markdown?
Закончите строку двумя пробелами или оставьте пустую строку, чтобы начать новый абзац. В комментариях GitHub часто работает и обычный перенос.
Что такое GitHub Flavored Markdown?
Расширение Markdown от GitHub, которое добавляет таблицы, списки задач, зачёркивание, ограждённые блоки кода и автоматические ссылки.
Как сделать сворачиваемый блок?
Оберните содержимое в теги details со строкой summary. GitHub и многие инструменты показывают его как блок, который раскрывается по щелчку.
Как писать блоки кода?
Поставьте три обратных апострофа на строке до и после кода и добавьте язык после первых трёх, например ```python, для подсветки.
Можно ли проверить Markdown здесь?
Да. Напишите или загрузите любой пример в песочницу и сразу увидите результат.