Skip to content

Commit 1e3dfc4

Browse files
committed
Refactor prose
1 parent f46e566 commit 1e3dfc4

File tree

1 file changed

+38
-15
lines changed

1 file changed

+38
-15
lines changed

readme.md

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

3-
Check if a [node][] is a [**transparent**][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 `node` is a [*transparent*][spec]
12+
[*element*][element].
13+
14+
## Install
615

716
[npm][]:
817

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

1322
## Usage
1423

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

1827
transparent({
@@ -33,23 +42,25 @@ transparent({
3342

3443
### `transparent(node)`
3544

36-
Check if the given value is a [**transparent**][spec] [element][].
45+
Check if the given value is a [*transparent*][spec] [*element*][element].
3746

3847
###### Parameters
3948

40-
`node` (`*`) — Value to check.
49+
* `node` (`*`) — Value to check, probably [`Element`][element].
4150

4251
###### Returns
4352

4453
`boolean` — whether `node` passes the test.
4554

4655
## Contribute
4756

48-
See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
57+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
4958
started.
59+
See [`support.md`][support] for ways to get help.
5060

51-
This organisation has a [Code of Conduct][coc]. By interacting with this
52-
repository, organisation, or community you agree to abide by its terms.
61+
This project has a [Code of Conduct][coc].
62+
By interacting with this repository, organisation, or community you agree to
63+
abide by its terms.
5364

5465
## License
5566

@@ -69,22 +80,34 @@ repository, organisation, or community you agree to abide by its terms.
6980

7081
[downloads]: https://www.npmjs.com/package/hast-util-transparent
7182

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

74-
[chat]: https://spectrum.chat/unified/rehype
95+
[chat]: https://spectrum.chat/unified/syntax-tree
7596

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

7899
[license]: license
79100

80101
[author]: https://wooorm.com
81102

82-
[node]: https://github.com/syntax-tree/hast#node
103+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
83104

84-
[element]: https://github.com/syntax-tree/hast#element
105+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
106+
107+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
85108

86109
[spec]: https://html.spec.whatwg.org/#transparent-content-models
87110

88-
[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md
111+
[hast]: https://github.com/syntax-tree/hast
89112

90-
[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md
113+
[element]: https://github.com/syntax-tree/hast#element

0 commit comments

Comments
 (0)