Skip to content

Commit 41db178

Browse files
committed
Refactor prose
1 parent a0343d4 commit 41db178

File tree

1 file changed

+36
-11
lines changed

1 file changed

+36
-11
lines changed

readme.md

+36-11
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
1-
# mdast-squeeze-paragraphs [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
1+
# mdast-squeeze-paragraphs
22

3-
Remove empty paragraphs from [**mdast**][mdast] syntax trees.
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]
10+
11+
[**mdast**][mdast] utility to remove empty paragraphs from a tree.
412

513
Paragraphs are considered empty if they do not contain non-whitespace
614
characters.
715

8-
## Installation
16+
## Install
917

1018
[npm][]:
1119

12-
```bash
20+
```sh
1321
npm install mdast-squeeze-paragraphs
1422
```
1523

@@ -43,7 +51,8 @@ Yields:
4351

4452
### `squeezeParagraphs(tree)`
4553

46-
Modifies tree in-place. Returns `tree`.
54+
Modifies [tree][] in-place.
55+
Returns `tree`.
4756

4857
## Related
4958

@@ -52,11 +61,13 @@ Modifies tree in-place. Returns `tree`.
5261

5362
## Contribute
5463

55-
See [`contributing.md` in `syntax-tree/mdast`][contributing] for ways to get
64+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
5665
started.
66+
See [`support.md`][support] for ways to get help.
5767

58-
This organisation has a [Code of Conduct][coc]. By interacting with this
59-
repository, organisation, or community you agree to abide by its terms.
68+
This project has a [Code of Conduct][coc].
69+
By interacting with this repository, organisation, or community you agree to
70+
abide by its terms.
6071

6172
## License
6273

@@ -76,17 +87,31 @@ repository, organisation, or community you agree to abide by its terms.
7687

7788
[downloads]: https://www.npmjs.com/package/mdast-squeeze-paragraphs
7889

90+
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-squeeze-paragraphs.svg
91+
92+
[size]: https://bundlephobia.com/result?p=mdast-squeeze-paragraphs
93+
94+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
95+
96+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
97+
98+
[collective]: https://opencollective.com/unified
99+
79100
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
80101

81-
[chat]: https://spectrum.chat/unified/remark
102+
[chat]: https://spectrum.chat/unified/syntax-tree
82103

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

85106
[license]: license
86107

87-
[contributing]: https://github.com/syntax-tree/mdast/blob/master/contributing.md
108+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
109+
110+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
111+
112+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
88113

89-
[coc]: https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md
114+
[tree]: https://github.com/syntax-tree/unist#tree
90115

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

0 commit comments

Comments
 (0)