Клавиатура GitHub Markdown онлайн: таблицы, задачи и алерты
Таблицы, списки задач и алерты: то, чего нет в обычном Markdown.
Предпросмотр
Предпросмотр примерный: он показывает смысл разметки, а не то, как её нарисует конкретное приложение. Шрифты, цвета и отступы везде свои, а часть возможностей зависит от версии.
0 симв.
Что пишет каждая кнопка
| Действие | Синтаксис | Примечание |
|---|---|---|
| B | **bold** |
Жирный |
| I | _italic_ |
Курсив |
| S | ~~strikethrough~~ |
Зачёркнутый - расширение GitHub, в обычном Markdown его нет |
| Code | `code` |
Код в строке |
| Sub | <sub>small</sub> |
Нижний индекс - GitHub разрешает этот HTML-тег |
| H1 | # Heading |
Заголовок 1-го уровня |
| H2 | ## Heading |
Заголовок 2-го уровня |
| H3 | ### Heading |
Заголовок 3-го уровня |
| Quote | > quoted |
Цитата |
| List | - item |
Маркированный список |
| Task | - [ ] to do |
Список задач - GitHub показывает его кликабельными флажками |
| Code block | ```js
code
``` |
Блок кода (в тройных обратных кавычках): язык после обратных кавычек включает подсветку |
| Table | | a | b |
| --- | --- | |
Таблица - расширение GitHub, в обычном Markdown таблиц нет |
| Note | > [!NOTE] |
Плашка: NOTE, TIP, IMPORTANT, WARNING или CAUTION |
| Warning | > [!WARNING] |
Плашка с предупреждением |
| Details | <details><summary>Title</summary> … </details> |
Сворачиваемый блок |
| Footnote | [^1] … [^1]: the note |
Сноска - нужна парная строка с её текстом |
| Link | [text](https://example.com) |
Ссылка |
| Image |  |
Изображение |
| Escape | *not italic* |
Ставит обратную косую черту перед \ ` * _ и другими символами, чтобы они оставались видны как есть, а не превращались в разметку. Выделите текст или просто поставьте курсор на строку |
Телефон собирает файл приложения - поэтому это дольше обычной загрузки.
Ищите этот значок: GitHub Markdown
Половина этого вовсе не Markdown
Таблицы, списки задач, зачёркивание, сноски и алерты [!NOTE] придумал GitHub. На GitHub они отображаются, а в генераторе статических сайтов, чате или превью редактора остаются набором символов. Поэтому эта страница отделена от страницы с обычным Markdown.
Разметка для issues, pull request и README
GitHub Flavored Markdown - это CommonMark плюс дополнения GitHub: таблицы для сравнений, списки задач в issues, алерты для предупреждений в README и сворачиваемые блоки для длинных логов.
Кнопка таблицы вставляет каркас сразу со строкой-разделителем из дефисов, которую чаще всего забывают. Алерты пишутся точно так, как ждёт GitHub: тип заглавными буквами в квадратных скобках с восклицательным знаком.
Как пользоваться
- Напишите текст и выделите фрагмент. Кнопка обернёт выделение нужной разметкой.
- Вставьте каркас таблицы и заполните его. Строка-разделитель уже на месте, выравнивать столбцы в исходнике не нужно.
- Скопируйте текст в issue или файл. Нажмите "Копировать всё" и вставьте, а черновик останется здесь.
Вопросы и ответы
Алерты работают везде на GitHub?
В issues, pull request, обсуждениях, комментариях и Markdown-файлах репозитория да. Вне GitHub они превращаются в обычную цитату, и текст остаётся читаемым.
Почему таблица не отображается?
Почти всегда виновата строка-разделитель под заголовком: она обязательна, и в каждом столбце нужно минимум три дефиса. Ещё одна частая причина - нет пустой строки перед таблицей.
Это то же самое, что GitLab Markdown?
Близко, но не одно и то же: у GitLab свои дополнения поверх той же основы, и для него есть отдельная страница.
