Skip to content

Commit 271925e

Browse files
committed
Refactor prose
1 parent dfc7536 commit 271925e

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

readme.md

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# mdast-util-phrasing [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
1+
# mdast-util-phrasing
22

3-
Check if a [MDAST][] (markdown) [node][] is a phrasing element.
3+
[![Build][build-badge]][build]
4+
[![Coverage][coverage-badge]][coverage]
5+
[![Downloads][downloads-badge]][downloads]
6+
[![Size][size-badge]][size]
7+
[![Sponsors][sponsors-badge]][collective]
8+
[![Backers][backers-badge]][collective]
9+
[![Chat][chat-badge]][chat]
410

5-
## Installation
11+
Check if a [mdast][] [node][] is [phrasing content][phrasing].
12+
13+
## Install
614

715
[npm][]:
816

9-
```bash
17+
```sh
1018
npm install mdast-util-phrasing
1119
```
1220

1321
## Usage
1422

15-
```javascript
23+
```js
1624
var phrasing = require('mdast-util-phrasing')
1725

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

3543
###### Parameters
3644

37-
`node` (`*`) — Value to check.
45+
`node` (`*`) — Value to check, typically a [node][].
3846

3947
###### Returns
4048

41-
`boolean` — whether `node` passes the test.
49+
`boolean` — whether `node` is [phrasing content][phrasing].
4250

4351
## Contribute
4452

45-
See [`contributing.md` in `syntax-tree/mdast`][contributing] for ways to get
53+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
4654
started.
55+
See [`support.md`][support] for ways to get help.
4756

48-
This organisation has a [Code of Conduct][coc]. By interacting with this
49-
repository, organisation, or community you agree to abide by its terms.
57+
This project has a [Code of Conduct][coc].
58+
By interacting with this repository, organisation, or community you agree to
59+
abide by its terms.
5060

5161
## License
5262

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

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

79+
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-phrasing.svg
80+
81+
[size]: https://bundlephobia.com/result?p=mdast-util-phrasing
82+
83+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
84+
85+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
86+
87+
[collective]: https://opencollective.com/unified
88+
6989
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
7090

71-
[chat]: https://spectrum.chat/unified/remark
91+
[chat]: https://spectrum.chat/unified/syntax-tree
7292

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

7595
[license]: license
7696

7797
[author]: https://draft.li
7898

79-
[node]: https://github.com/syntax-tree/mdast#ast
99+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
100+
101+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
102+
103+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
80104

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

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

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

0 commit comments

Comments
 (0)