# markdown-chalk

> markdown parser to chalk pretty printing in the terminal

Latest version **2.1.0** (published 2018-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-chalk
pnpm add markdown-chalk
yarn add markdown-chalk
bun add markdown-chalk
```

Provides the command `markdown-chalk`.

## 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 | 2.1.0 |
| Published | 2018-10-15 |
| First published | 2015-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Lewis Cowper |
| Maintainers | lewiscowper |
| Keywords | markdown, chalk, terminal |

## Links

- npm: https://www.npmjs.com/package/markdown-chalk
- Repository: https://github.com/lewiscowper/markdown-chalk
- Homepage: https://github.com/lewiscowper/markdown-chalk#readme
- Issues: https://github.com/lewiscowper/markdown-chalk/issues
- npm.io page: https://npm.io/package/markdown-chalk

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [yargs](https://npm.io/package/yargs.md) ^4.2.0
- [marked](https://npm.io/package/marked.md) ^0.3.5
- [word-wrap](https://npm.io/package/word-wrap.md) ^1.1.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

- 2.1.0 (latest) — 2018-10-15
- 2.0.0 — 2018-03-22
- 1.4.0 — 2016-02-11
- 1.3.0 — 2015-11-19
- 1.2.0 — 2015-11-19
- 1.1.0 — 2015-10-08
- 1.0.0 — 2015-09-27

## README

# Markdown-Chalk

A markdown parser that uses chalk to print a markdown file nicely in the terminal.

# CLI usage

```
Usage: markdown-chalk --input [Markdown File] --lineLength [num]

Options:
  -h, --help        Show help                                          [boolean]
  -i, --input                                  [required] [default: "README.md"]
  -l, --lineLength                                                 [default: 80]
```

# Require() usage

```javascript

var markdownChalk = require('markdown-chalk');

var result = markdownChalk('# Some Markdown string');

console.log(result);

```

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