Клавиатура GitLab Markdown онлайн: диаграммы, формулы и задачи
Диаграммы и формулы прямо из блока кода: GitLab это умеет, GitHub нет.
Предпросмотр
Предпросмотр примерный: он показывает смысл разметки, а не то, как её нарисует конкретное приложение. Шрифты, цвета и отступы везде свои, а часть возможностей зависит от версии.
0 симв.
Что пишет каждая кнопка
| Действие | Синтаксис | Примечание |
|---|---|---|
| B | **bold** |
Жирный |
| I | _italic_ |
Курсив |
| S | ~~strikethrough~~ |
Зачёркнутый |
| Code | `code` |
Код в строке |
| H1 | # Heading |
Заголовок 1-го уровня |
| H2 | ## Heading |
Заголовок 2-го уровня |
| Quote | > quoted |
Цитата |
| List | - item |
Маркированный список |
| Task | - [ ] to do |
Список задач |
| Code block | ```ruby
code
``` |
Блок кода с языком |
| Table | | a | b |
| --- | --- | |
Таблица |
| Mermaid | ```mermaid
mermaid
``` |
Диаграмма из текста - возможность GitLab |
| Math | ```math
formula
``` |
Блок формулы |
| Details | <details><summary>Title</summary> … </details> |
Сворачиваемый блок |
| Link | [text](https://example.com) |
Ссылка |
| Image |  |
Изображение |
| Escape | *not italic* |
Ставит обратную косую черту перед \ ` * _ и другими символами, чтобы они оставались видны как есть, а не превращались в разметку. Выделите текст или просто поставьте курсор на строку |
Телефон собирает файл приложения - поэтому это дольше обычной загрузки.
Ищите этот значок: GitLab
Диаграмма, записанная текстом
Блок кода с пометкой mermaid GitLab показывает не как код, а как диаграмму. Схема архитектуры живёт в issue текстом: её видно в diff, по ней работает поиск, и поправить её может любой, без перерисовки картинки. С формулами в блоке math то же самое.
Та же основа, другие дополнения
У GitLab и GitHub общее ядро Markdown, а расширения разные. Таблицы, списки задач и зачёркивание есть у обоих, но GitLab рисует диаграммы и формулы из блоков кода, а у GitHub есть алерты [!NOTE], которых нет в GitLab.
Здесь собрано то, что работает в issues, merge request, сниппетах и вики GitLab. Кнопки диаграммы и формулы вставляют рабочий каркас, который остаётся только отредактировать.
Как пользоваться
- Напишите описание или комментарий. Выделите фрагмент и нажмите кнопку, разметка встанет вокруг него.
- Вставьте каркас диаграммы и поправьте его. Кнопка Mermaid даёт рабочий граф из двух узлов.
- Спрячьте длинный вывод в блок details. Логам и стектрейсам место под строкой-заголовком, а не посреди текста.
Вопросы и ответы
Алерты GitHub здесь работают?
Нет, блоки > [!NOTE] есть только в GitHub. В GitLab они выглядят как обычная цитата со словом в скобках.
Где отображаются диаграммы Mermaid?
В issues, merge request, комментариях, сниппетах и вики, то есть везде, где GitLab показывает Markdown. Вне GitLab блок останется кодом, и читатель увидит исходник диаграммы.
Как записать формулу?
В блоке с пометкой math формула пишется в нотации LaTeX. Для коротких выражений есть и запись в строке.
