#markdown #less #cat

bin+lib mdcat

cat for markdown: Show markdown documents in terminals

48 releases (25 breaking)

Uses new Rust 2021

0.28.0 Jul 31, 2022
0.26.1 Feb 12, 2022
0.25.0 Dec 23, 2021
0.24.2 Nov 19, 2021
0.8.0 Feb 15, 2018

#484 in Command line utilities

Download history 377/week @ 2022-06-16 224/week @ 2022-06-23 336/week @ 2022-06-30 366/week @ 2022-07-07 422/week @ 2022-07-14 492/week @ 2022-07-21 579/week @ 2022-07-28 490/week @ 2022-08-04 608/week @ 2022-08-11 494/week @ 2022-08-18 242/week @ 2022-08-25 669/week @ 2022-09-01 369/week @ 2022-09-08 184/week @ 2022-09-15 262/week @ 2022-09-22 364/week @ 2022-09-29

1,362 downloads per month
Used in 6 crates (5 directly)

MPL-2.0 license

335KB
3K SLoC

mdcat

Fancy cat for Markdown (that is, CommonMark):

$ mdcat sample.md

mdcat showcase with different colour themes

mdcat in kitty, with Tango Light, Solarized Light, and Dracula (from left to right), and PragmataPro as font.

Features

mdcat works best with iTerm2 or Kitty, and a good terminal font with italic characters. Then it

  • nicely renders all basic CommonMark syntax (no tables or footnotes though),
  • highlights code blocks with syntect,
  • shows links, and also images inline in supported terminals (see above, where "Rust" is a clickable link!),
  • adds jump marks for headings in iTerm2 (jump forwards and backwards with ⇧⌘↓ and ⇧⌘↑).
Terminal Basic syntax Syntax highlighting Images Jump marks
Basic ANSI
Windows ConEmu
Windows 10 console
Generic VTE 0.50 or newer¹
Terminology
iTerm2 ✓ 2)
kitty ✓ 2)
WezTerm ✓ 2)
foot
  1. VTE is Gnome’s terminal emulation library used by many popular terminal emulators on Linux, including Gnome Terminal, Xfce Terminal, Tilix, etc.
  2. SVG images require rsvg-convert from librsvg.

Not supported:

Usage

Try mdcat --help or read the mdcat(1) manpage.

Installation

  • 3rd party packages:
    • Homebrew: brew install mdcat
    • MacPorts: sudo port install mdcat
    • Arch Linux: pacman -S mdcat
    • Void Linux: xbps-install -S mdcat
    • Nixpkgs: nix-env -i mdcat
    • Scoop: scoop install mdcat
    • Chocolatey: choco install mdcat
  • You can also build mdcat manually with cargo install mdcat.

Requirements

  • For image type detection either:
    • a system-wide shared mime database, or,
    • if mdcat is built without default features, the file tool with support for --brief and --mime-type flags.

Troubleshooting

mdcat can output extensive tracing information when asked to. Run a debug build of mdcat with $MDCAT_LOG=trace for complete tracing information, or with $MDCAT_LOG=mdcat::render=trace to trace only rendering.

Note: Tracing information is mostly elided in release builds; use a debug build for complete output.

Future plans

  • Figure out a better way to show HTML #3.
  • CommonMark extensions: Footnotes #1.
  • CommonMark extensions: Tables #2.
  • Ignore soft wraps and wrap inline text a column limit instead #4.

License

Copyright Sebastian Wiesner sebastian@swsnr.de

Binaries are subject to the terms of the Mozilla Public License, v. 2.0, see LICENSE.

Most of the source is subject to the terms of the Mozilla Public License, v. 2.0, see LICENSE, unless otherwise noted; some files are subject to the terms of the Apache 2.0 license, see http://www.apache.org/licenses/LICENSE-2.0

Dependencies

~38MB
~692K SLoC