Расширения Markdown

Поддерживаются следующие расширения Markdown (описание некоторых см. тут):

Abbreviation (сокращения)

[наверх]

Наведите мышь на сокращение: HTML.

Admonition (замечания)

[наверх]

Заголовок совета

Вот совет по оформлению замечаний: заголовки должны быть в двойных кавычках, иначе их рендеринг не произойдёт. Пустые строки недопустимы, иначе новый абзац выйдет за пределы рамки.

Заголовок вопроса

Это вопрос.

Заголовок предупреждения

Это предупреждение.

Заголовок информации

Это информация.

Заголовок отрывка

Это отрывок.

Заголовок успеха

Это успех.

Заголовок неудачи

Это неудача.

Заголовок опасности

Это опасность.

Заголовок ошибки

Это ошибка.

Заголовок примера

Это пример.

Заголовок цитаты

Это цитата.

Поддерживаются вложенные элементы:

Где-то на белом свете - там, где всегда мороз...
...Трутся спиной медведи о земную ось.

© к/ф «Кавказская пленница» 🎦

[наверх]

Добавляет ссылки на заголовки: ссылка.

Attributes (атрибуты)

[наверх]

HTML-атрибуты - это например CSS для текста.

[наверх]

Это расширение делает кликабельными ссылки: https://www.example.com.

Definition (определения)

[наверх]

Это расширение создает списки в стиле <dt> / <dd>:

Термин 1
Определение термина 1
Термин 2
Определение термина 2

Footnotes (сноски)

[наверх]

Что такое CSS1, см. внизу страницы.

Emoji (эмоции)

[наверх]

Список поддерживаемых эмоций формально не определён, но в целом работает список Github.

😄 👍 🎉

GfmTaskList (списки задач)

[наверх]

  •  задача выполнена
  •  задача не выполнена

Gitlab

[наверх]

Это все возможности Markdown, которые поддерживает Gitlab, например диаграммы в формате Mermaid (см. поддерживаемые типы диаграмм):

---
title: Автомат для приготовления чая и кофе (машина состояний)
---
stateDiagram-v2
    direction LR
    state ChooseWhatToMake <<choice>>
    
    %% labels
    state "Ожидание нажатия кнопки" as WaitForButton
    state "Вскипятить воду" as BoilWater
    state "Приготовить кофе" as MakeCoffee
    state "Приготовить чай" as MakeTea
    state "Добавить лемон" as AddLemon
    state "Добавить сахар" as AddSugar
    state "Уведомить о готовности напитка" as SignalReady
    
    %% styles
    classDef TeaClass fill:#752400
    classDef CoffeeClass fill:#a76939,color:white
    class MakeTea TeaClass
    class MakeCoffee CoffeeClass
    
    [*] --> WaitForButton: Автомат включён
    WaitForButton --> BoilWater: Нажата кнопка
    BoilWater --> ChooseWhatToMake: Вода закипела
    
    %% choice: tea
    ChooseWhatToMake --> MakeTea: Приготовить чай?
    state MakeTea {
        direction LR
        AddLemon --> AddSugar
    }
    MakeTea --> SignalReady: Чай готов
    
    %% choice: coffee
    ChooseWhatToMake --> MakeCoffee: Приготовить кофе?
    note right of MakeCoffee
        Растворимый кофе / молотый кофе / зерновой кофе.
    end note
    MakeCoffee --> SignalReady: Кофе готов
    
    SignalReady --> WaitForButton: Чашка взята

gitGraph title Git-коммиты
    commit id: "Initial commit" tag: "v1.0.0"
    branch develop
    commit
    branch bugfix/TICKET-1
    commit
    commit
    checkout develop
    commit
    merge bugfix/TICKET-1
    checkout main
    merge develop tag: "v1.0.1"

pie title Погода в прошлом месяце
    "Солнечные дни" : 22
    "Дождливые дни" : 5
    "Туманные дни" : 3

PlantUML

[наверх]

Диаграммы в формате PlantUML:

User UI User User UI UI clickButton()
ClassAtitle: StringgetTitle() ClassBdoSomething() Uses

MediaTags (медиа-вставки)

[наверх]

Позволяет вставлять из Интернета:

звук:
веб-страницу:
картинку:
site logo
видео:

TableOfContents (оглавления)

[наверх]

См. оглавление вверху страницы.

Tables (таблицы)

[наверх]

Заголовок 1 Заголовок 2
текст 1 текст 2
текст 3 текст 4

Typographic (типографские символы)

[наверх]

Преобразует в красивые HTML entities:

  • “двойные кавычки”
  • ‘одинарные кавычки’
  • «угловые кавычки»
  • многоточие: …
  • короткое тире: –
  • длинное тире: —

  1. Cascading Style Sheets

    ↩