Skip to content
Markdown in your terminal
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
cli.js
package.json
readme.md
yarn.lock

readme.md

tm▾

Markdown in your terminal

  • Works with links, tables, code blocks, and more
  • Pipable : cat readme.md | tm
  • Adapts to your terminal theme
  • Compatible with CI/CD

Install

npm install -g terminal-markdown

(or yarn global add terminal-markdown)

Usage

tm <your-md-file>

or

cat <your-md-file> | tm

The second usage allows you to combine terminal-markdown with other commands.

🍿 For example, you can request this readme (that you are currently reading) and display it :

curl -s https://raw.githubusercontent.com/lucleray/terminal-markdown/master/readme.md | tm

Support

✔︎ Terminal-markdown supports everything (CommonMark and Github Flavoured Markdown), except :

  • Images are replaced by alt texts
  • HTML won't be displayed
  • Footnotes (but they're also not supported on Github)
  • Alignment inside tables is not supported

🚨 Depending on your terminal, some things might change :

Roadmap

You can’t perform that action at this time.