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.
Sebastian Wiesner af9a6fe459 Patch pulldown-cmark 3 weeks ago
.github/workflows Remove outdated comment 1 month ago
sample Render strike through text 1 year ago
screenshots Update showcase screenshots 2 years ago
scripts Fix shell script style 1 month ago
src Test whether footnotes are disabled 3 weeks ago
tests Extract parser creation with supported options 3 weeks ago
.gitattributes Disable line ending conversion on Windows 3 months ago
.gitignore cargo new 2 years ago
CHANGELOG.md Release 0.20.0 1 month ago
CODE_OF_CONDUCT.md Add a code of conduct 2 years ago
CONTRIBUTING.md Add contributing docs 2 years ago
Cargo.lock Patch pulldown-cmark 3 weeks ago
Cargo.toml Patch pulldown-cmark 3 weeks ago
LICENSE Relicense as MPL 2 months ago
README.md Attempt to fix screenshot link 1 month ago
build.rs Build and package shell completions 1 month ago
clippy.toml Make clippy ignore CommonMark in docs 2 years ago

README.md

mdcat

cat for Markdown (that is, CommonMark):

$ mdcat sample.md

mdcat showcase with different colour themes

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

Features

mdcat works best with iTerm2 or a compatible terminal emulator, 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 images inline in supported terminals (see above, where “Pixabay” is a clickable link!),
  • adds jump marks for headings in iTerm2 (jump forwards and backwards with ⇧⌘↓ and ⇧⌘↑).
Terminal Basic syntax Syntax highlighting Links Images Jump marks
Basic ANSI
Windows ConEmu
Windows 10 console
Generic VTE 0.50 or newer¹
Terminology
iTerm2
kitty

¹) VTE is Gnome’s terminal emulation library used by many popular terminal emulators on Linux, including Gnome Terminal, Xfce Terminal, Tilix, etc.

Not supported:

Installation

Binaries

The Releases page provides pre-build binaries for Linux, macOS and Windows.

Note: The Linux build is statically linked and requires the curl command to fetch images from HTTP(S).

3rd party packages

Some package repositories include mdcat:

Building with rustup

You can also build mdcat manually with cargo install mdcat.

SVG support

mdcat needs rsvg-convert to show SVG images in iTerm2 and kitty; otherwise mdcat only shows the image title and URL for SVG images. On macOS you can install the librsvg formula from Homebrew, on Linux the tool is typically part of the librsvg-bin package (or similar).

Terminology renders SVG directly and needs no additional tools.

Future plans

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