Markdown is everywhere these days, from GitHub README files and developer documentation to AI agent instructions. You can open these files with cat or less, but the output still contains Markdown characters such as #, ** and backticks.
mdcat is a command-line Markdown viewer that renders the content directly in your terminal. Instead of reading raw markup, you see formatted headings, lists, links and syntax-highlighted code blocks. There is no need to open a browser or graphical editor.
Where to download mdcat
Get mdcat from its maintained GitHub repository or download a suitable prebuilt binary from GitHub Releases. The original repository is archived, so the maintained fork is the better starting point for a new installation.
On Linux, after downloading and extracting the binary for your system, you can place it in your user executable directory:
mkdir -p "$HOME/.local/bin"
install -m 755 mdcat "$HOME/.local/bin/mdcat"
export PATH="$HOME/.local/bin:$PATH"
mdcat --version
The install command above assumes the extracted mdcat executable is in your current directory. To build and install through Rust instead, use:
cargo install mdcat
This requires the Rust toolchain and the build dependencies. On systems with Homebrew, another option is brew install mdcat.
Read formatted Markdown in the terminal
Once installed, try these commands:
mdcat README.md
mdcat docs/installation.md
mdcat --theme dracula README.md
Modern terminal emulators can display styled text and clickable links. Some terminals, including kitty, WezTerm and iTerm2, also support inline images. The maintained version offers colour themes and additional rendering features.
Create mdless using a symbolic link
For longer Markdown files, mdless provides a browsing experience similar to the familiar less command. You do not need to install another program. mdcat checks the name used to launch it: when called mdless, it enables a pager automatically.
Create a symbolic link (soft link) in a directory included in your PATH:
mkdir -p "$HOME/.local/bin"
ln -s "$(command -v mdcat)" "$HOME/.local/bin/mdless"
mdless README.md
If ~/.local/bin is not on your PATH, add it to your shell configuration. The command assumes mdcat is already installed and discoverable with command -v mdcat. If mdless already exists, inspect it before creating the link.
When the pager is less, you can scroll with the arrow keys or Space, search with /, and press q to exit. Alternatively, run mdcat --paginate README.md without creating the link.
Final thoughts
If you regularly read README files, technical notes or Markdown-based AI agent instructions over SSH, mdcat is a useful small addition to your terminal workflow. Use mdcat for quick formatted output and mdless when you need to browse a longer document.
Project: github.com/BIRSAx2/mdcat