https://github.com/lucleray/terminal-markdown

Markdown in your terminal
https://github.com/lucleray/terminal-markdown

markdown markdown-viewer md terminal

Last synced: 9 days ago
JSON representation

Markdown in your terminal

• Host: GitHub
• URL: https://github.com/lucleray/terminal-markdown
• Owner: lucleray
• Created: 2018-05-31T20:08:25.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-05-31T20:15:46.000Z (over 6 years ago)
• Last Synced: 2024-12-13T01:32:59.460Z (9 days ago)
• Topics: markdown, markdown-viewer, md, terminal
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/terminal-markdown
• Size: 10.7 KB
• Stars: 2
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# 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 

```

or

```

cat  | 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 :

* [Links](https://google.fr) are [not always supported](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)

* _Emphasis_ is not always supported

* ~~Delete~~ is not always supported

### Roadmap

* [x] Links in [compatible terminals](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)

* [ ] Syntax highlighting for code blocks

* [ ] Table alignment

* [ ] [Images ?](https://github.com/sindresorhus/terminal-image)