Skip to content

Commit be4600e

Browse files
committed
Refactor prose
1 parent 7a8eca0 commit be4600e

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

readme.md

+38-15
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,27 @@
1-
# hast-util-sectioning [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
1+
# hast-util-sectioning
22

3-
Check if a [node][] is a [**sectioning**][spec] [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+
[**hast**][hast] utility to check if an [*element*][element] is
12+
[*sectioning*][spec].
13+
14+
## Install
615

716
[npm][]:
817

9-
```bash
18+
```sh
1019
npm install hast-util-sectioning
1120
```
1221

1322
## Usage
1423

15-
```javascript
24+
```js
1625
var sectioning = require('hast-util-sectioning')
1726

1827
sectioning({
@@ -39,15 +48,17 @@ sectioning({
3948

4049
### `sectioning(node)`
4150

42-
Check if the given value is a [**sectioning**][spec] [element][].
51+
Check if the given value is a [*sectioning*][spec] [*element*][element].
4352

4453
## Contribute
4554

46-
See [`contribute.md` in `syntax-tree/hast`][contribute] for ways to get
55+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
4756
started.
57+
See [`support.md`][support] for ways to get help.
4858

49-
This organisation has a [Code of Conduct][coc]. By interacting with this
50-
repository, organisation, or community you agree to abide by its terms.
59+
This project has a [Code of Conduct][coc].
60+
By interacting with this repository, organisation, or community you agree to
61+
abide by its terms.
5162

5263
## License
5364

@@ -67,22 +78,34 @@ repository, organisation, or community you agree to abide by its terms.
6778

6879
[downloads]: https://www.npmjs.com/package/hast-util-sectioning
6980

81+
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-sectioning.svg
82+
83+
[size]: https://bundlephobia.com/result?p=hast-util-sectioning
84+
85+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
86+
87+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
88+
89+
[collective]: https://opencollective.com/unified
90+
7091
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
7192

72-
[chat]: https://spectrum.chat/unified/rehype
93+
[chat]: https://spectrum.chat/unified/syntax-tree
7394

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

7697
[license]: license
7798

7899
[author]: https://wooorm.com
79100

80-
[node]: https://github.com/syntax-tree/unist#node
101+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
81102

82-
[element]: https://github.com/syntax-tree/unist#element
103+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
83104

84-
[spec]: https://html.spec.whatwg.org/#sectioning-content
105+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
85106

86-
[contribute]: https://github.com/syntax-tree/hast/blob/master/contributing.md
107+
[hast]: https://github.com/syntax-tree/hast
87108

88-
[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md
109+
[element]: https://github.com/syntax-tree/hast#element
110+
111+
[spec]: https://html.spec.whatwg.org/#sectioning-content

0 commit comments

Comments
 (0)