# cli-md

> Markdown for your terminal

Latest version **1.2.0** (published 2015-11-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli-md
pnpm add cli-md
yarn add cli-md
bun add cli-md
```

Provides the command `cli-md`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2015-11-25 |
| First published | 2014-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 26 |
| Author | Finn Pauls |
| Maintainers | finnpauls |
| Keywords | markdown, terminal |

## Links

- npm: https://www.npmjs.com/package/cli-md
- Repository: https://github.com/finnp/cli-md
- Issues: https://github.com/finnp/cli-md/issues
- npm.io page: https://npm.io/package/cli-md

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^0.5.1
- [marked](https://npm.io/package/marked.md) ^0.3.2
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.4.6
- [marked-terminal](https://npm.io/package/marked-terminal.md) ^1.2.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2015-11-25
- 1.1.0 — 2015-11-25
- 1.0.0 — 2015-03-11
- 0.1.0 — 2014-08-06

## README

# cli-md
[![NPM](https://nodei.co/npm/cli-md.png)](https://nodei.co/npm/cli-md/)

Transform markdown to terminal colors. Install with `npm install cli-md`

It is inspired by and similar to [msee](https://www.npmjs.org/package/msee),
but the implementation is using [marked-terminal](https://github.com/mikaelbr/marked-terminal)
as a marked renderer internally.

## Usage
```js
var md = require('cli-md')
md('# markdown')
```

## Command line usage
```
$ cli-md < Readme.md
$ cli-md Readme.md
```
Which would look something like this:
![Photo](example.png)

---
_Source: https://npm.io/package/cli-md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._