mdcat
| Crates.io | mdcat |
| lib.rs | mdcat |
| version | 2.2.0 |
| source | src |
| created_at | 2018-01-19 15:24:53.062469 |
| updated_at | 2024-07-11 09:16:56.549027 |
| description | cat for markdown: Show markdown documents in terminals |
| homepage | https://github.com/swsnr/mdcat |
| repository | https://github.com/swsnr/mdcat |
| max_upload_size | |
| id | 47416 |
| size | 434,954 |
Sebastian Wiesner (swsnr)
documentation
README
mdcat
Fancy cat for Markdown (that is, CommonMark):
$ mdcat sample.md
mdcat in WezTerm, with "One Light (base16)", "Gruvbox Light", and "Darcula (base16)" (from left to right), and JetBrains Mono as font.
Features
mdcat works best with iTerm2, WezTerm, and kitty, and a good terminal font with italic characters.
Then it
- nicely renders all basic CommonMark syntax,
- 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 10 console | ✓ | ✓ | ||
| Terminology | ✓ | ✓ | ✓ | |
| iTerm2 | ✓ | ✓ | ✓³ | ✓ |
| kitty | ✓ | ✓ | ✓³ | |
| WezTerm | ✓ | ✓ | ✓³ | |
| VSCode | ✓ | ✓ | ✓³ |
- mdcat requires that the terminal supports strikethrough formatting and inline links. It will not render strikethrough text and links correctly on terminals that don't support these (e.g. the Linux text console)
- VTE is Gnome’s terminal emulation library used by many popular terminal emulators on Linux, including Gnome Terminal, Xfce Terminal, Tilix, etc.
- SVG images are rendered with resvg, see SVG support.
Not supported:
- CommonMark extensions for footnotes and tables.
Usage
Try mdcat --help or read the mdcat(1) manpage.
Installation
- Release binaries built on Github Actions.
- 3rd party packages at Repology
- You can also build
mdcatmanually withcargo install mdcat(see below for details).
mdcat can be linked or copied to mdless; if invoked as mdless it automatically uses pagination.
Building
Run cargo build --release.
The resulting mdcat executable links against the system's SSL library, i.e. openssl on Linux.
To build a self-contained executable use cargo build --features=static; the resulting executable uses a pure Rust SSL implementation.
It still uses the system's CA roots however.
The build process also generates the following additional files in $OUT_DIR:
- Completions for Bash, Zsh, Fish, and Powershell, for both
mdcatandmdless, incompletionssub-directory. - A
mdcat.1manpage, build frommdcat.1.adocwith theasciidoctorcommand from AsciiDoctor. Ifasciidoctoris not found the build script prints a warning.
These additional artifacts are included in the release builds. If you package mdcat you may want to include these files too.
You may also want to include an mdless link to mdcat (see above).
Troubleshooting
mdcat can output extensive tracing information when asked to.
Run mdcat with $MDCAT_LOG=trace for complete tracing information, or with $MDCAT_LOG=mdcat::render=trace to trace only rendering.
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