Skip to content

Commit 5ae5e32

Browse files
committed
Refactor docs
1 parent 770d1f3 commit 5ae5e32

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

readme.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,14 @@ npm install remark-gemoji
1212

1313
## Usage
1414

15-
Say `example.js` looks as follows (note `remark-gemoji` isn’t used):
15+
Say `example.js` looks as follows (note: `remark-gemoji` isn’t used):
1616

1717
```javascript
1818
var unified = require('unified');
1919
var parse = require('remark-parse');
2020

2121
var tree = unified()
22-
.use(parse)
23-
.data('settings', {pedantic: true, position: false})
22+
.use(parse, {pedantic: true, position: false})
2423
.parse(':heavy_check_mark:');
2524

2625
console.dir(tree, {depth: null});
@@ -46,8 +45,9 @@ If we now add `remark-gemoji` by applying the following diff to `example.js`:
4645
+var gemoji = require('remark-gemoji');
4746

4847
var tree = unified()
48+
.use(parse, {pedantic: true, position: false})
4949
+ .use(gemoji)
50-
.use(parse)
50+
.parse(':heavy_check_mark:');
5151
```
5252

5353
If we now run `node example` again, you’ll see the following:
@@ -65,7 +65,7 @@ If we now run `node example` again, you’ll see the following:
6565

6666
Gemoji short-code support in [**remark**][remark].
6767
This doesn’t do much other than creating whole [`Text`][text] nodes
68-
for emoji, and ensuring gemoji short-codes with underscores are not
68+
for gemoji, and ensuring gemoji short-codes with underscores are not
6969
seen as emphasis in pedantic mode.
7070

7171
> **Note**: when compiling, `pedantic` must be false! Otherwise,
@@ -84,7 +84,8 @@ seen as emphasis in pedantic mode.
8484

8585
## Contribute
8686

87-
See [`contribute.md` in `remarkjs/remarkj`][contribute] for ways to get started.
87+
See [`contribute.md` in `remarkjs/remarkjs`][contribute] for ways to get
88+
started.
8889

8990
This organisation has a [Code of Conduct][coc]. By interacting with this
9091
repository, organisation, or community you agree to abide by its terms.

0 commit comments

Comments
 (0)