mdcat

cat for CommonMark: Show CommonMark (a standardized Markdown dialect) documents on text terminals.

$ mdcat sample.md

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

Features

• All CommonMark syntax
• Syntax highlighting for code blocks
• Image support with iTerm2
• iTerm2 jump marks for headings: Jump forwards and backwards to headings with ⇧⌘↓ and ⇧⌘↑ respectively.

Not supported:

• CommonMark extensions: Footnotes and Tables
• Images from remote URLs
• Re-filling paragraphs

Installation and Requirements

Install Rust and run cargo install mdcat.

To keep mdcat up to date install cargo-update and run cargo install-update mdcat.

mdcat works best with iTerm2 or a compatible terminal emulator, and a good terminal font which includes italic characters.

Future plans

• [ ] Fetch remote images to show them inline.
• [ ] Figure out a better way to show HTML GH-3.
• [ ] CommonMark extensions: Footnotes GH-1.
• [ ] CommonMark extensions: Tables GH-2.
• [ ] Ignore soft wraps and wrap inline text a column limit instead GH-4.

License

Copyright 2018 Sebastian Wiesner sebastian@swsnr.de

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.