GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → lunaryorn → Mdcat

lunaryorn / Mdcat

Licence: mpl-2.0
cat for markdown

Programming Languages

rust
11053 projects

Labels

markdownterminaliterm2cat

Projects that are alternatives of or similar to Mdcat

Relaxed Terminal Themes
🕶️ A relaxed terminal theme to take a more relaxed view of things. For iTerm, Hyper, the macOS Terminal and a bunch of others.
Stars: ✭ 382 (-63.37%)
Mutual labels:  terminal, iterm2
Autocomplete
Autocomplete for terminals on MacOS
Stars: ✭ 569 (-45.45%)
Mutual labels:  terminal, iterm2
Lookatme
An interactive, terminal-based markdown presenter
Stars: ✭ 392 (-62.42%)
Mutual labels:  terminal, markdown
Termimad
A library to display rich (Markdown) snippets and texts in a rust terminal application
Stars: ✭ 293 (-71.91%)
Mutual labels:  terminal, markdown
Dotfiles
Configurations for the tools I use every day
Stars: ✭ 898 (-13.9%)
Mutual labels:  terminal, iterm2
Pokemon Terminal
Pokemon terminal themes.
Stars: ✭ 3,874 (+271.43%)
Mutual labels:  terminal, iterm2
Imgcat
It's like cat, but for images.
Stars: ✭ 577 (-44.68%)
Mutual labels:  terminal, iterm2
Itomate
Automate your iTerm layouts and session setup
Stars: ✭ 262 (-74.88%)
Mutual labels:  terminal, iterm2
Cocalc
CoCalc: Collaborative Calculation in the Cloud
Stars: ✭ 888 (-14.86%)
Mutual labels:  terminal, markdown
Rich
Rich is a Python library for rich text and beautiful formatting in the terminal.
Stars: ✭ 31,664 (+2935.86%)
Mutual labels:  terminal, markdown
Yonce
👑 Queen Bey-inspired themes for all your favs.
Stars: ✭ 280 (-73.15%)
Mutual labels:  terminal, iterm2
Onehalf
Clean, vibrant and pleasing color schemes for Vim, Sublime Text, iTerm, gnome-terminal and more.
Stars: ✭ 974 (-6.62%)
Mutual labels:  terminal, iterm2
Tty Markdown
Convert a markdown document or text into a terminal friendly output.
Stars: ✭ 275 (-73.63%)
Mutual labels:  terminal, markdown
Iterm2 Color Schemes
Over 250 terminal color schemes/themes for iTerm/iTerm2. Includes ports to Terminal, Konsole, PuTTY, Xresources, XRDB, Remmina, Termite, XFCE, Tilda, FreeBSD VT, Terminator, Kitty, MobaXterm, LXTerminal, Microsoft's Windows Terminal, Visual Studio, Alacritty
Stars: ✭ 20,828 (+1896.93%)
Mutual labels:  terminal, iterm2
Ltfinderbuttons
My Finder buttons collection for macOS.
Stars: ✭ 269 (-74.21%)
Mutual labels:  terminal, iterm2
Wild Cherry
👸🌷👹 A fairy-tale inspired theme, with tasteful use of emojis
Stars: ✭ 443 (-57.53%)
Mutual labels:  terminal, iterm2
Go Termd
Package termd provides terminal markdown rendering, with code block syntax highlighting support.
Stars: ✭ 223 (-78.62%)
Mutual labels:  terminal, markdown
catimg
Print an image of a cat to the iTerm2 terminal
Stars: ✭ 13 (-98.75%)
Mutual labels:  cat, iterm2
Nord Iterm2
An arctic, north-bluish clean and elegant iTerm2 color scheme.
Stars: ✭ 651 (-37.58%)
Mutual labels:  terminal, iterm2
Termd
Render markdown in the terminal
Stars: ✭ 32 (-96.93%)
Mutual labels:  terminal, markdown
View All Similar Projects ➔

mdcat

Fancy cat for Markdown (that is, CommonMark):

$ mdcat sample.md

mdcat showcase with different colour themes

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 "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 ✓ ✓ ✓ ✓ 2) ✓
kitty ✓ ✓ ✓ ✓ 2)
  1. VTE is Gnome’s terminal emulation library used by many popular terminal emulators on Linux, including Gnome Terminal, Xfce Terminal, Tilix, etc.
  2. SVG images require rsvg-convert from librsvg.

Not supported:

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 to mdless for a variant of mdcat which paginates by default (like mdcat -p).
  • 3rd party packages:
    • Homebrew: brew 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
  • You can also build mdcat manually with cargo 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 [email protected]

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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].