You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Basti 28a2d25799
Document requirements
1 month ago
sample Create new screenshot 2 years ago
screenshots Create new screenshot 2 years ago
scripts Remove package script 5 months ago
src Fix the build on Windows 3 months ago
tests Cleanup broken pipe test 5 months ago
.gitattributes Disable line ending conversion on Windows 2 years ago
.gitignore Add a manpage 2 years ago
CHANGELOG.md Release 0.27.1 3 months ago
CODE_OF_CONDUCT.md Add a code of conduct 4 years ago
Cargo.lock Release 0.27.1 3 months ago
Cargo.toml Release 0.27.1 3 months ago
LICENSE Relicense as MPL 2 years ago
README.md Document requirements 1 month ago
build.rs Migrate to clap 3 5 months ago
clippy.toml Make clippy ignore CommonMark in docs 5 years ago
mdcat.1.adoc Release 0.27.1 3 months ago

README.md

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