https://github.com/raineorshine/marked-terminal-cli
A better way to read README's in the cli!
https://github.com/raineorshine/marked-terminal-cli
Last synced: 7 months ago
JSON representation
A better way to read README's in the cli!
- Host: GitHub
- URL: https://github.com/raineorshine/marked-terminal-cli
- Owner: raineorshine
- License: isc
- Created: 2021-05-09T16:36:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-09T16:46:07.000Z (over 4 years ago)
- Last Synced: 2025-03-10T15:09:32.453Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 125 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - raineorshine/marked-terminal-cli - A better way to read README's in the cli! (others)
README
# marked-terminal-cli
[](https://npmjs.org/package/marked-terminal-cli)
A better way to read README's in the CLI!
Read and print markdown files using [marked-terminal](https://github.com/mikaelbr/marked-terminal).
## Install
```sh
npm install -g marked-terminal-cli
```
## Usage
```sh
marked-terminal-cli README.md
```
You may need to force color when piping to less:
```sh
FORCE_COLOR=1 marked-terminal-cli README.md | less -r
```
Add handy aliases to your ~/.bashrc:
```sh
alias md=marked-terminal-cli
# read markdown file with marked-terminal-cli and pass to less
lessmd() {
FORCE_COLOR=1 marked-terminal-cli "$@" | less -r
}
```