# sharkdown

> markdown in your shell

Latest version **0.1.1** (published 2019-04-02) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install sharkdown
pnpm add sharkdown
yarn add sharkdown
bun add sharkdown
```

Provides the command `sharkdown`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2019-04-02 |
| First published | 2013-10-06 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tom MacWright |
| Maintainers | tmcw |
| Keywords | markdown, shell, sh, highlighting, stream, format, mkd |

## Links

- npm: https://www.npmjs.com/package/sharkdown
- npm.io page: https://npm.io/package/sharkdown

## Dependencies (3)

- [split](https://npm.io/package/split.md) ~0.2.10
- [cardinal](https://npm.io/package/cardinal.md) ~0.4.2
- [minimist](https://npm.io/package/minimist.md) 0.0.5

## Recent versions

- 0.1.1 (latest) — 2019-04-02
- 0.1.0 — 2013-10-23
- 0.0.1 — 2013-10-06

## README

[![Build Status](https://secure.travis-ci.org/tmcw/sharkdown.png?branch=master)](http://travis-ci.org/tmcw/sharkdown)

# sharkdown

![](https://i.cloudup.com/FdxECDQECh.png)

## usage

    npm install --save sharkdown

Or as a handy utility:

    npm install sharkdown -g

And then you can do:

    sharkdown file.md
    sharkdown < "markdown data"

## api

### `sharkdown(str)`

Takes a string, returns a string with markdown encoded as control codes for a
shell.

### `sharkdown()`

Returns a through-stream for pipes.

## example

```js
var sharkdown = require('sharkdown');

process.stdin
    .pipe(sharkdown())
    .pipe(process.stdout);
```

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