Skip to content

Commit

Permalink
Refactor prose
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed May 24, 2019
1 parent dfc7536 commit 271925e
Showing 1 changed file with 38 additions and 14 deletions.
52 changes: 38 additions & 14 deletions readme.md
@@ -1,18 +1,26 @@
# mdast-util-phrasing [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
# mdast-util-phrasing

Check if a [MDAST][] (markdown) [node][] is a phrasing element.
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

## Installation
Check if a [mdast][] [node][] is [phrasing content][phrasing].

## Install

[npm][]:

```bash
```sh
npm install mdast-util-phrasing
```

## Usage

```javascript
```js
var phrasing = require('mdast-util-phrasing')

phrasing({
Expand All @@ -34,19 +42,21 @@ Check if the given value is a phrasing element.

###### Parameters

`node` (`*`) — Value to check.
`node` (`*`) — Value to check, typically a [node][].

###### Returns

`boolean` — whether `node` passes the test.
`boolean` — whether `node` is [phrasing content][phrasing].

## Contribute

See [`contributing.md` in `syntax-tree/mdast`][contributing] for ways to get
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
started.
See [`support.md`][support] for ways to get help.

This organisation has a [Code of Conduct][coc]. By interacting with this
repository, organisation, or community you agree to abide by its terms.
This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

Expand All @@ -66,20 +76,34 @@ repository, organisation, or community you agree to abide by its terms.

[downloads]: https://www.npmjs.com/package/mdast-util-phrasing

[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-phrasing.svg

[size]: https://bundlephobia.com/result?p=mdast-util-phrasing

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg

[chat]: https://spectrum.chat/unified/remark
[chat]: https://spectrum.chat/unified/syntax-tree

[npm]: https://docs.npmjs.com/cli/install

[license]: license

[author]: https://draft.li

[node]: https://github.com/syntax-tree/mdast#ast
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/master/support.md

[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md

[mdast]: https://github.com/syntax-tree/mdast

[contributing]: https://github.com/syntax-tree/mdast/blob/master/contributing.md
[node]: https://github.com/syntax-tree/mdast#nodes

[coc]: https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
[phrasing]: https://github.com/syntax-tree/mdast#phrasingcontent

0 comments on commit 271925e

Please sign in to comment.