Начало работы
Введение
Что отображает mdv и с чего начать.
Что такое mdv?
mdv, написанный на Rust, отображает Markdown в терминалах с поддержкой ANSI. Читайте README, инструкции и заметки рядом с редактором, оставаясь в командной строке.
Программа работает с файлами, каталогами и стандартным вводом. Выбирайте тему, настраивайте разметку и используйте встроенные режимы выбора документов и постраничного просмотра.
Основные возможности
- Удобный Markdown: заголовки, подсветка кода, таблицы, выноски, списки задач и ссылки.
- Своя разметка: ширина, перенос строк, отступы, выравнивание заголовков и поведение таблиц.
- Темы и пресеты: встроенные палитры и собственная конфигурация в YAML.
- Интерактивное чтение: выбор Markdown-файлов, поиск по документу и открытие исходника в редакторе.
- Обновление на лету: повторное отображение при изменении файла.
- Командная строка: чтение из потока, управление цветом и экспорт HTML.
Быстрый старт
Установите mdv из crates.io. Нужен Rust 1.95 или новее:
cargo install mdv
mdv README.mdПопробуйте тему, отслеживание файла или выбор документа в текущем каталоге:
mdv --theme catppuccin README.md
mdv --monitor notes.md
mdv -iЧто дальше?
- Установка: установщики, Cargo, RPM, Arch, Nix, сборка из исходников и обновление.
- Использование, выбор документов, просмотр и обновление на лету: способы чтения и управление.
- Разметка, код, математика, выноски, списки, ссылки, front matter и HTML: подробности отображения.
- Темы, поля темы, пресеты и свои синтаксисы: настройка оформления.
- Конфигурация, все настройки YAML, переменные окружения и полный справочник CLI: каждый доступный параметр.
Разработка описывает сборку и проверки проекта. В репозитории GitHub находятся исходники и примеры.