Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 

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

Releases

No releases published

Packages

No packages published