mdcatcat for markdown
mdcat
Fancy cat
for Markdown (that is, CommonMark):
$ mdcat sample.md
mdcat in kitty, with Tango Light, Dracula, and Solarized Light (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 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 | Links | Images | Jump marks |
---|---|---|---|---|---|
Basic ANSI | ✓ | ✓ | |||
Windows ConEmu | ✓ | ✓ | |||
Windows 10 console | ✓ | ✓ | |||
Generic VTE 0.50 or newer¹ | ✓ | ✓ | ✓ | ||
Terminology | ✓ | ✓ | ✓ | ✓ | |
iTerm2 | ✓ | ✓ | ✓ | ✓ 2) | ✓ |
kitty | ✓ | ✓ | ✓ | ✓ 2) | |
WezTerm | ✓ | ✓ | ✓ | ✓ 2) |
- VTE is Gnome’s terminal emulation library used by many popular terminal emulators on Linux, including Gnome Terminal, Xfce Terminal, Tilix, etc.
- SVG images require
rsvg-convert
from librsvg.
Not supported:
- CommonMark extensions: Footnotes and tables
- Re-filling paragraphs
Usage
Try mdcat --help
or read the mdcat(1) manpage.
Installation
- The Releases page provides pre-build binaries for Linux, macOS and Windows.
- Tip: You can copy or hard-link
mdcat
tomdless
for a variant ofmdcat
which paginates by default (likemdcat -p
).
- Tip: You can copy or hard-link
- 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
- Homebrew:
- You can also build
mdcat
manually withcargo install mdcat
.
Future plans
- 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 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
评论
Markdown
Markdown是一个Web上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前Stackoverflow网站使用这种格式来提问。一个文本实例:###Hea
Markdown
0
蝉知markdown编辑器markdown
本插件是1.x版本基于osc开源的thinker-md制作的根据蝉知zentaophp框架插件扩展机制编写的只适合于蝉知4.4版本的markdown编辑器。基于thinker-md集成的开源marke
蝉知markdown编辑器markdown
0
Markdown Reader
MarkdownReader是Chrome的扩展,用来阅读Markdown格式文档。软件功能:渲染样式美化,看起文档更舒服代码块增加代码高亮和行号功能监测文件修改,并自动重新加载并渲染markdown
Markdown Reader
0
Standard markdown
这是标准的Markdown规范实现,包括C和JavaScript的实现。其中C语言的实现包含一个开发包和命令行工具用来转换Markdown到HTML。采用标准C99编写,无需第三方库依赖。
Standard markdown
0