# bisheng-plugin-description

> To extract description from Markdown.

Latest version **0.1.4** (published 2017-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install bisheng-plugin-description
pnpm add bisheng-plugin-description
yarn add bisheng-plugin-description
bun add bisheng-plugin-description
```

## 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.4 |
| Published | 2017-10-17 |
| First published | 2016-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Benjy Cui |
| Maintainers | benjycui |
| Keywords | bisheng, plugin, description |

## Links

- npm: https://www.npmjs.com/package/bisheng-plugin-description
- Repository: https://github.com/benjycui/bisheng-plugin-description
- Homepage: https://github.com/benjycui/bisheng-plugin-description#readme
- Issues: https://github.com/benjycui/bisheng-plugin-description/issues
- npm.io page: https://npm.io/package/bisheng-plugin-description

## Dependencies (1)

- [jsonml.js](https://npm.io/package/jsonml.js.md) ^0.1.0

## Recent versions

- 0.1.4 (latest) — 2017-10-17
- 0.1.3 — 2017-10-16
- 0.1.2 — 2017-02-09
- 0.1.1 — 2016-05-12
- 0.1.0 — 2016-05-12
- 0.1.0-beta.0 — 2016-05-12

## README

# bisheng-plugin-description

[![](https://img.shields.io/travis/benjycui/bisheng.svg?style=flat-square)](https://travis-ci.org/benjycui/bisheng)
[![npm package](https://img.shields.io/npm/v/bisheng-plugin-description.svg?style=flat-square)](https://www.npmjs.org/package/bisheng-plugin-description)
[![NPM downloads](http://img.shields.io/npm/dm/bisheng-plugin-description.svg?style=flat-square)](https://npmjs.org/package/bisheng-plugin-description)
[![Dependency Status](https://david-dm.org/benjycui/bisheng-plugin-description.svg?style=flat-square)](https://david-dm.org/benjycui/bisheng-plugin-description)

To extract description from Markdown.

## Usage

Install:

```bash
npm i --save bisheng-plugin-description
```

Add 'bisheng-plugin-description' to `bisehng.config.js`'s plugins.

```js
module.exports = {
  plugins: ['bisheng-plugin-description'],
};
```

In Markdown:

```markdown
---
title: ...
...
---

This is description.

---

This is main content.
```

In template:

```jsx
<div>
  { utils.toReactComponent(pageData.description) }
</div>
```

## Liscense

MIT

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