Skip to content

Commit c453c08

Browse files
committed
Refactor prose
1 parent fc9f2fa commit c453c08

File tree

1 file changed

+37
-15
lines changed

1 file changed

+37
-15
lines changed

readme.md

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

3-
Parse [mdast][] comment markers.
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+
[**mdast**][mdast] utility to parse comment markers.
12+
13+
## Install
614

715
[npm][]:
816

9-
```bash
17+
```sh
1018
npm install mdast-comment-marker
1119
```
1220

1321
## Usage
1422

15-
```javascript
23+
```js
1624
var marker = require('mdast-comment-marker');
1725

1826
console.log(marker({
@@ -65,7 +73,7 @@ Parse a comment marker.
6573

6674
###### Parameters
6775

68-
* `node` ([`Node`][node]) — Node to parse
76+
* `node` ([`Node`][node]) — [Node][] to parse
6977

7078
###### Returns
7179

@@ -85,11 +93,13 @@ A comment marker.
8593

8694
## Contribute
8795

88-
See [`contributing.md` in `syntax-tree/mdast`][contributing] for ways to get
96+
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
8997
started.
98+
See [`support.md`][support] for ways to get help.
9099

91-
This organisation has a [Code of Conduct][coc]. By interacting with this
92-
repository, organisation, or community you agree to abide by its terms.
100+
This project has a [Code of Conduct][coc].
101+
By interacting with this repository, organisation, or community you agree to
102+
abide by its terms.
93103

94104
## License
95105

@@ -109,22 +119,34 @@ repository, organisation, or community you agree to abide by its terms.
109119

110120
[downloads]: https://www.npmjs.com/package/mdast-comment-marker
111121

122+
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-comment-marker.svg
123+
124+
[size]: https://bundlephobia.com/result?p=mdast-comment-marker
125+
126+
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
127+
128+
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
129+
130+
[collective]: https://opencollective.com/unified
131+
112132
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
113133

114-
[chat]: https://spectrum.chat/unified/remark
134+
[chat]: https://spectrum.chat/unified/syntax-tree
135+
136+
[npm]: https://docs.npmjs.com/cli/install
115137

116138
[license]: license
117139

118140
[author]: https://wooorm.com
119141

120-
[npm]: https://docs.npmjs.com/cli/install
142+
[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md
143+
144+
[support]: https://github.com/syntax-tree/.github/blob/master/support.md
145+
146+
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
121147

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

124150
[node]: https://github.com/syntax-tree/unist#node
125151

126152
[marker]: #marker
127-
128-
[contributing]: https://github.com/syntax-tree/mdast/blob/master/contributing.md
129-
130-
[coc]: https://github.com/syntax-tree/mdast/blob/master/code-of-conduct.md

0 commit comments

Comments
 (0)