Markdown in your terminal
npm install terminal-markdownMarkdown 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
``
npm install -g terminal-markdown
(or yarn global add terminal-markdown)
`
tm
or
`
cat
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
✔︎ Terminal-markdown supports everything (CommonMark and Github Flavoured Markdown), except :
* Images are replaced by alt texts
* HTML won't be displayed
* Footnotes but they are also not supported on Github
* Alignment of tables is not taken in account
🚨 Depending on your terminal, some things might change :
* Links are not always supported
* _Emphasis_ is not always supported
* ~~Delete~~ is not always supported
* [x] Links in compatible terminals
* [ ] Syntax highlighting for code blocks
* [ ] Table alignment
* [ ] Images ?