Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BubuAnabelas/markcat
:eyeglasses: Markdown files terminal viewer.
https://github.com/BubuAnabelas/markcat
cli javascript markdown nodejs syntax-highlighting terminal
Last synced: 29 days ago
JSON representation
:eyeglasses: Markdown files terminal viewer.
- Host: GitHub
- URL: https://github.com/BubuAnabelas/markcat
- Owner: BubuAnabelas
- License: mit
- Created: 2018-01-19T06:35:33.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T18:29:47.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T19:10:08.559Z (2 months ago)
- Topics: cli, javascript, markdown, nodejs, syntax-highlighting, terminal
- Language: JavaScript
- Homepage:
- Size: 1.46 MB
- Stars: 42
- Watchers: 4
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/code-of-conduct.md
Awesome Lists containing this project
- awesome-markdown - markcat - Markdown files terminal viewer. :gem: _`cat` with Markdown highlight._ ![Mac OS X][macosx] ![Linux][linux] ![Windows][windows] (Tools / Miscellaneous)
README
# markcat
> Markdown files terminal viewer.
_Based on [marked-terminal](https://github.com/mikaelbr/marked-terminal)_
- **Code highlight** right out of the box.
- Based on the popular [**marked**](https://github.com/chjj/marked) package.
- **Github Flavored Markdown** support.
- Renders your emojis :tada:.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Example](#example)
- [License](#license)
## Install
Make sure you have Node.js version 8 or higher installed
```sh
$ npm install -g markcat
```
## Usage
```
$ markcat [filename]
View Markdown files in the terminal
Options:
--version Show version number
--help Show help
--no-gfm Disable GitHub Flavored Markdown
--no-tables Disable GFM tables. This option requires the gfm option
to be true
--no-breaks Disable GFM line breaks. This option requires the gfm
option to be true
-p, --pedantic Conform to original's markdown.pl as much as possible.
Don't fix any of the original markdown bugs or poor
behavior
-s, --sanitize Sanitize the output. Ignore any HTML that has been input
-S, --no-smartlists Use smarter list behavior than the original markdown
--smartypants Use "smart" typographic punctuation for things like
quotes and dashes
```
## Example
[](https://asciinema.org/a/xR59kF01pnzoKLpJ3OVbfyMlM)
## License
[MIT License](https://oss.ninja/mit/bubuanabelas) © Joaquín Serna