Оформление

Выноски

Типы выносок, стили, значки, пользовательские определения и YAML.

Стиль и параметры

  • -C, --callout-style <pretty|simple>[:show-icons;show-simple-icons;fold-icons;label-inside;uppercase] - стиль callout-блоков и правила отображения подписи. show-icons использует глифы Nerd Font, а show-simple-icons - переносимые ASCII-маркеры вроде [i], [*], [!] и [x]. Эти два параметра нельзя комбинировать. label-inside поддерживается только с pretty, fold-icons требует show-icons.
  • --custom-callout <name:icon=...,color=...;...> - переопределение или добавление подписей callout. icon и color можно указывать по отдельности; формат цвета как в --custom-theme.
  • Для корректного отображения иконок, включённых через show-icons и fold-icons, нужны шрифты Nerd Fonts в терминале. Для show-simple-icons они не требуются.

Оформление выноски

mdv --no-config --theme catppuccin --cols 64 --callout-style pretty example.md
Вывод mdvВерсия 6.1.1
╭─ Note ────────────────────────╮
│ Читайте Markdown в терминале. │
╰───────────────────────────────╯

╭─ Tip ─────────────────────╮
│ Выберите тему для работы. │
╰───────────────────────────╯
Исходный Markdown
> [!NOTE]
> Читайте Markdown в терминале.

> [!TIP]
> Выберите тему для работы.

Значки выносок

Без значков, ASCII-маркеры или значки Nerd Font.

mdv --no-config --theme catppuccin --cols 64 --callout-style pretty example.md
Вывод mdvВерсия 6.1.1
╭─ Note ────────────────────────╮
│ Читайте Markdown в терминале. │
╰───────────────────────────────╯

╭─ Tip ─────────────────────╮
│ Выберите тему для работы. │
╰───────────────────────────╯
Исходный Markdown
> [!NOTE]
> Читайте Markdown в терминале.

> [!TIP]
> Выберите тему для работы.

Положение подписи

mdv --no-config --theme catppuccin --cols 64 --callout-style pretty example.md
Вывод mdvВерсия 6.1.1
╭─ Note ────────────────────────╮
│ Читайте Markdown в терминале. │
╰───────────────────────────────╯

╭─ Tip ─────────────────────╮
│ Выберите тему для работы. │
╰───────────────────────────╯
Исходный Markdown
> [!NOTE]
> Читайте Markdown в терминале.

> [!TIP]
> Выберите тему для работы.

Регистр подписи

mdv --no-config --theme catppuccin --cols 64 --callout-style pretty example.md
Вывод mdvВерсия 6.1.1
╭─ Note ────────────────────────╮
│ Читайте Markdown в терминале. │
╰───────────────────────────────╯

╭─ Tip ─────────────────────╮
│ Выберите тему для работы. │
╰───────────────────────────╯
Исходный Markdown
> [!NOTE]
> Читайте Markdown в терминале.

> [!TIP]
> Выберите тему для работы.

Исходный Markdown

> [!NOTE]
> Keep related information together.

> [!WARNING]
> Check the selected destination before continuing.

Встроенные типы: note, abstract, info, todo, tip, success, question, warning, failure, danger, bug, example, quote. Индикаторы сворачивания относятся к оформлению; содержимое в терминале остаётся видимым.

Индикатор сворачивания

mdv --no-config --theme catppuccin --cols 64 --callout-style 'pretty:show-icons' example.md
Вывод mdvВерсия 6.1.1
╭─  Подробности ──────────────╮
│ Содержимое остаётся видимым. │
╰──────────────────────────────╯
Исходный Markdown
> [!NOTE]- Подробности
> Содержимое остаётся видимым.

Примеры

Свой цвет выноски

mdv --no-config --theme catppuccin --cols 64 example.md
Вывод mdvВерсия 6.1.1
╭─ Note ────────────────────────╮
│ Читайте Markdown в терминале. │
╰───────────────────────────────╯

╭─ Tip ─────────────────────╮
│ Выберите тему для работы. │
╰───────────────────────────╯
Исходный Markdown
> [!NOTE]
> Читайте Markdown в терминале.

> [!TIP]
> Выберите тему для работы.

YAML и приоритет цветов

callout_style:
  style: pretty
  show_simple_icons: true
  label_inside: true
  uppercase: false
custom_callout:
  tip:
    icon: "*"
    color: green
  custom:
    color: "#89b4fa"

Пользовательские определения объединяются по имени и свойствам. Переопределение только цвета сохраняет значок. null очищает свойство или запись, корневые null и {} очищают всю настройку. В CLI также доступны tip:color=null, tip:null и --custom-callout null.

При одинаковом приоритете источника цвет типа из пользовательского определения важнее общего callout.label, затем callout.palette. Цвета CLI выше по приоритету, чем цвета конфигурации. Рамка использует отдельный callout.border; см. справочник полей темы.