Markdown, оформленный прямо в терминале

Быстрый просмотрщик с темами оформления, подсветкой синтаксиса, гибкой разметкой, ссылками и обновлением при изменении файла.

mdv README.md
mdv
 
 Быстрый просмотрщик Markdown с темами для терминала

 Возможности
  
  - Отображение прямо в терминале
  - Темы оформления: `nord` `gruvbox` `tokyonight`
  - Обновление с `--monitor`
  
 Preset  │ Wrap 
─────────┼──────
 reader  │ word 
 compact │ char 
  
    fn main() { println!("hello, mdv"); }

Для удобного чтения

Аккуратное отображение в терминалах с поддержкой ANSI под ваше рабочее пространство.

Гибкое оформление

Встроенные темы, отдельные палитры кода и настройка цветов интерфейса и синтаксиса на лету. Создайте собственную тему в YAML.

nord
gruvbox
tokyonight
catppuccin

$ mdv --monitor notes.md

notes.md
# Работа продолжается
Запишите мысль. Продолжайте читать.

правка → сохранение → обновление

Обновление на лету

Редактируйте в одной панели, читайте в другой. --monitor обновляет документ при изменении исходного файла.

Разметка под контролем

Задавайте ширину, перенос строк, оформление заголовков и таблиц. Выбирайте кликабельные ссылки, адреса в тексте или таблицу ссылок в конце.

--cols100--wrapword--heading-layoutlevel--link-styleinlinetable--table-wrapfit

Всё необходимое

Маленький инструмент. Много возможностей.

Подсветка синтаксиса

Блоки кода с отдельной палитрой, номерами строк и значками языков по желанию.

Готовые пресеты

Начните с reader, compact, pretty или showcase. Сохраняйте свои сочетания настроек в YAML.

Встроенный просмотр

Ищите, выделяйте и копируйте текст. Переходите к строке исходника или открывайте файл в редакторе.

Выбор документов

Находите Markdown-файлы в интерактивном режиме с учётом скрытых файлов и правил Git.

С любого места

Переходите к разделу с --from или читайте с конца с --reverse.

Удобно для скриптов

Читайте stdin, экспортируйте HTML, управляйте цветом и переносите конфигурацию между компьютерами.

Установка

Выберите удобный способ.

cargo install mdv

Нужны Rust 1.95 или новее и Cargo. Поддерживаются Windows, macOS и Linux.

Предпочитаете готовый файл? Скачать релиз ↗

Использование

Откройте файл, следите за изменениями во время работы или читайте Markdown из другой команды.

# Открыть Markdown-файл

mdv README.md

# Обновлять документ при изменении файла

mdv --monitor README.md

# Выбрать Markdown-файл в текущем каталоге

mdv -i

# Прочитать Markdown из другой команды

cat notes.md | mdv

# Применить встроенный пресет

mdv --preset reader README.md

Вопросы и ответы

Коротко о главном.

Какие терминалы поддерживаются?

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

Как изменить тему?

Передайте --theme nord для одного запуска или задайте theme в конфигурации. Создать её можно командой mdv --init-config.

Можно читать из stdin?

Да. Передайте Markdown через cat file.md | mdv или явно выберите стандартный ввод командой mdv -.

У mdv открытый исходный код?

Да. mdv написан на Rust, распространяется по лицензии MIT и разрабатывается на GitHub.

Ваш Markdown. Ваш терминал.

Установите одной командой и начните читать Markdown прямо в терминале.

cargo install mdv
Документация