# markdown-summary

> extract summary/preview text from markdown

Latest version **1.0.3** (published 2017-09-28) · MIT license · 0 weekly downloads

## Install

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

## 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.0.3 |
| Published | 2017-09-28 |
| First published | 2017-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | 'Dominic Tarr' |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/markdown-summary
- Repository: https://github.com/dominictarr/markdown-summary
- Issues: https://github.com/dominictarr/markdown-summary/issues
- npm.io page: https://npm.io/package/markdown-summary

## Recent versions

- 1.0.3 (latest) — 2017-09-28
- 1.0.2 — 2017-09-28
- 1.0.0 — 2017-09-28

## README

# markdown-summary

extract useful things like a title, a summary, and a preview image from a freeform
markdown post.

``` js
var msum = require('markdown-summary')

var title = msum.title(text) //the first line, or the first 80 chars or so
var summary = msum.summary(text) //the next line, or the rest of the first line (if a whole paragraph)
var image = msum.image(text) //the first embedded image ![...](...)

```

## License

MIT

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