mdcat

mdcat

Необычный cat для Markdown (то есть CommonMark):

 $ mdcat sample.md

mdcat в WezTerm со шрифтом «One Light (base16)», «Gruvbox Light» и «Darcula (base16)» (слева направо) и JetBrains Mono.

Функции

mdcat лучше всего работает с iTerm2, WezTerm и kitty, а также с хорошим шрифтом терминала с курсивом. Тогда это

• прекрасно отображает весь базовый синтаксис CommonMark,
• выделяет блоки кода с помощью Syntect,
• показывает ссылки, а также изображения, встроенные в поддерживаемые терминалы (см. выше, где «Rust» — кликабельная ссылка!),
• добавляет метки перехода для заголовков в iTerm2 (переход вперед и назад с помощью ⇧⌘↓ и ⇧⌘↑).

Терминал	Основной синтаксис	Подсветка синтаксиса	Изображения	Метки прыжка
Базовый ANSI¹	✓	✓
Консоль Windows 10	✓	✓
Терминология	✓	✓	✓
iTerm2	✓	✓	✓³	✓
Китти	✓	✓	✓³
ВезТерм	✓	✓	✓³
VSCode	✓	✓	✓³
Призрачный	✓	✓	✓³

1. mdcat требует, чтобы терминал поддерживал зачеркнутое форматирование и встроенные ссылки. Он не будет правильно отображать зачеркнутый текст и ссылки на терминалах, которые их не поддерживают (например, текстовая консоль Linux).
2. VTE — это библиотека эмуляции терминала Gnome, используемая многими популярными эмуляторами терминала в Linux, включая Gnome Terminal, Xfce Terminal, Tilix и т. д.
3. Изображения SVG отображаются с помощью resvg, см. раздел Поддержка SVG.

Не поддерживается:

• Расширение CommonMark для сносок.
• Встроенная разметка и перенос текста в ячейках таблицы.

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

Попробуйте mdcat --help или прочитайте справочную страницу mdcat(1).

Установка

• Выпускайте двоичные файлы, созданные на Github Actions.
• Сторонние пакеты в Repology
• Вы также можете собрать mdcat вручную с помощью cargo install mdcat (подробности см. ниже).

mdcat можно связать или скопировать в mdless ; если он вызывается как mdless он автоматически использует нумерацию страниц.

Здание

Запустите cargo build --release . Полученный исполняемый файл mdcat связывается с системной библиотекой SSL, то есть openssl в Linux.

Чтобы создать автономный исполняемый файл, используйте cargo build --features=static ; результирующий исполняемый файл использует чистую реализацию SSL на Rust. Однако он по-прежнему использует корни CA системы.

Упаковка

При упаковке mdcat вы можете включить следующие дополнительные артефакты:

• Символическая или жесткая ссылка с mdless на mdcat (см. выше).

• Завершения оболочки для соответствующих оболочек путем вызова mdcat --completions после сборки, например

  $ mdcat --completions fish > /usr/share/fish/vendor_completions.d/mdcat.fish
  $ mdcat --completions bash > /usr/share/bash-completion/completions/mdcat
  $ mdcat --completions zsh > /usr/share/zsh/site-functions/_mdcat
  # Same for mdless if you include it
  $ mdless --completions fish > /usr/share/fish/vendor_completions.d/mdless.fish
  $ mdless --completions bash > /usr/share/bash-completion/completions/mdless
  $ mdless --completions zsh > /usr/share/zsh/site-functions/_mdless

• Сборка man-страницы mdcat.1.adoc с использованием AsciiDoctor:

  $ asciidoctor -b manpage -a reproducible -o /usr/share/man/man1/mdcat.1 mdcat.1.adoc
  $ gzip /usr/share/man/man1/mdcat.1
  # If you include a mdless as above, you may also want to support man mdless
  $ ln -s mdcat.1.gz /usr/share/man/man1/mdless.1.gz 

Поиск неисправностей

mdcat может выводить обширную информацию для отслеживания, когда его об этом попросят. Запустите mdcat с $MDCAT_LOG=trace для получения полной информации о трассировке или с $MDCAT_LOG=mdcat::render=trace для отслеживания только рендеринга.

Лицензия

Авторские права принадлежат Себастьяну Визнеру [email protected]

На двоичные файлы распространяются условия Общественной лицензии Mozilla версии 2.0, см. ЛИЦЕНЗИЯ.

На большую часть исходного кода распространяются условия Общественной лицензии Mozilla версии 2.0, см. ЛИЦЕНЗИЯ, если не указано иное; на некоторые файлы распространяются условия лицензии Apache 2.0, см. http://www.apache.org/licenses/LICENSE-2.0.