Skip to content

Commit fbe4a32

Browse files
committed
Refactor prose
1 parent ed1e9a8 commit fbe4a32

File tree

1 file changed

+41
-26
lines changed

1 file changed

+41
-26
lines changed

readme.md

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,26 @@
33
[![Build][build-badge]][build]
44
[![Coverage][coverage-badge]][coverage]
55
[![Downloads][downloads-badge]][downloads]
6-
[![Chat][chat-badge]][chat]
6+
[![Size][size-badge]][size]
77
[![Sponsors][sponsors-badge]][collective]
88
[![Backers][backers-badge]][collective]
9+
[![Chat][chat-badge]][chat]
910

10-
Gemoji short-code support in [**remark**][remark].
11+
[**remark**][remark] plugin to parse Gemoji shortcodes.
1112

12-
## Installation
13+
## Install
1314

1415
[npm][]:
1516

16-
```bash
17+
```sh
1718
npm install remark-gemoji
1819
```
1920

20-
## Usage
21+
## Use
2122

2223
Say `example.js` looks as follows (note: `remark-gemoji` isn’t used):
2324

24-
```javascript
25+
```js
2526
var unified = require('unified')
2627
var parse = require('remark-parse')
2728

@@ -68,17 +69,17 @@ If we now run `node example` again, you’ll see the following:
6869

6970
## API
7071

71-
### `remark.use(gemoji)`
72+
### `remark().use(gemoji)`
7273

73-
Gemoji short-code support in [**remark**][remark].
74-
This doesn’t do much other than creating whole [`Text`][text] nodes
75-
for gemoji, and ensuring gemoji short-codes with underscores are not
76-
seen as emphasis in pedantic mode.
74+
Plugin to parse Gemoji shortcodes.
75+
This doesn’t do much other than creating whole [**Text**][text] nodes for
76+
Gemoji, and ensuring Gemoji shortcodes with underscores are not seen as emphasis
77+
in pedantic mode.
7778

78-
> **Note**: when compiling, `pedantic` must be false! Otherwise,
79-
> the underscores in gemoji short-codes are still escaped.
79+
> **Note**: when compiling, `pedantic` must be false!
80+
> Otherwise, the underscores in gemoji shortcodes are still escaped.
8081
>
81-
> Although, GitHub itself doesn’t care: :heavy_check_mark:.
82+
> Although, GitHub itself doesn’t care: `:heavy\_check\_mark:`.
8283
8384
## Related
8485

@@ -91,19 +92,21 @@ seen as emphasis in pedantic mode.
9192

9293
## Contribute
9394

94-
See [`contributing.md` in `remarkjs/remark`][contributing] for ways to get
95-
started.
95+
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
96+
to get started.
97+
See [`support.md`][support] for ways to get help.
9698

97-
This organisation has a [Code of Conduct][coc]. By interacting with this
98-
repository, organisation, or community you agree to abide by its terms.
99+
This project has a [Code of Conduct][coc].
100+
By interacting with this repository, organisation, or community you agree to
101+
abide by its terms.
99102

100103
## License
101104

102-
[MIT](license) © [Titus Wormer](https://wooorm.com)
105+
[MIT][license] © [Titus Wormer][author]
103106

104107
<!-- Definitions -->
105108

106-
[build-badge]: https://img.shields.io/travis/remarkjs/remark-gemoji.svg
109+
[build-badge]: https://img.shields.io/travis/remarkjs/remark-gemoji/master.svg
107110

108111
[build]: https://travis-ci.org/remarkjs/remark-gemoji
109112

@@ -115,18 +118,34 @@ repository, organisation, or community you agree to abide by its terms.
115118

116119
[downloads]: https://www.npmjs.com/package/remark-gemoji
117120

118-
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
121+
[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-gemoji.svg
119122

120-
[chat]: https://spectrum.chat/unified/remark
123+
[size]: https://bundlephobia.com/result?p=remark-gemoji
121124

122125
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
123126

124127
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
125128

126129
[collective]: https://opencollective.com/unified
127130

131+
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
132+
133+
[chat]: https://spectrum.chat/unified/remark
134+
128135
[npm]: https://docs.npmjs.com/cli/install
129136

137+
[health]: https://github.com/remarkjs/.github
138+
139+
[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md
140+
141+
[support]: https://github.com/remarkjs/.github/blob/master/support.md
142+
143+
[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md
144+
145+
[license]: license
146+
147+
[author]: https://wooorm.com
148+
130149
[remark]: https://github.com/remarkjs/remark
131150

132151
[text]: https://github.com/syntax-tree/mdast#textnode
@@ -136,7 +155,3 @@ repository, organisation, or community you agree to abide by its terms.
136155
[html-emoji-image]: https://github.com/jackycute/remark-html-emoji-image
137156

138157
[emoji-to-gemoji]: https://github.com/jackycute/remark-emoji-to-gemoji
139-
140-
[contributing]: https://github.com/remarkjs/remark/blob/master/contributing.md
141-
142-
[coc]: https://github.com/remarkjs/remark/blob/master/code-of-conduct.md

0 commit comments

Comments
 (0)