Skip to content

Commit 5b0043c

Browse files
committed
Add missing plugin to Using unified guide
Closes GH-11.
1 parent ead516d commit 5b0043c

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

Diff for: src/using-unified.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,13 @@ In the next section, we’ll make this more useful by introducing plugins.
113113
We’re still missing some things, notably a table of contents, and proper HTML
114114
document structure.
115115

116-
Respectively, we can use [`remark-toc`][toc] and [`rehype-document`][document]
117-
to do these two tasks.
116+
We can use [`remark-slug`][slug] and [`remark-toc`][toc] for the former, and
117+
[`rehype-document`][document] to do the latter tasks.
118118

119119
```bash sh
120120
$ npm install remark-toc rehype-document
121121
/Users/tilde/example
122+
122123
123124
124125
```
@@ -129,13 +130,15 @@ Let’s now use those two as well, by modifying our `index.js` file:
129130
var unified = require('unified')
130131
var stream = require('unified-stream')
131132
var markdown = require('remark-parse')
133+
+var slug = require('remark-slug')
132134
+var toc = require('remark-toc')
133135
var remark2rehype = require('remark-rehype')
134136
+var doc = require('rehype-document')
135137
var html = require('rehype-stringify')
136138

137139
var processor = unified()
138140
.use(markdown)
141+
+ .use(slug)
139142
+ .use(toc)
140143
.use(remark2rehype)
141144
+ .use(doc, {title: 'Contents'})
@@ -221,13 +224,15 @@ like so:
221224
+var vfile = require('to-vfile')
222225
+var report = require('vfile-reporter')
223226
var markdown = require('remark-parse')
227+
var slug = require('remark-slug')
224228
var toc = require('remark-toc')
225229
var remark2rehype = require('remark-rehype')
226230
var doc = require('rehype-document')
227231
var html = require('rehype-stringify')
228232

229233
var processor = unified()
230234
.use(markdown)
235+
.use(slug)
231236
.use(toc)
232237
.use(remark2rehype)
233238
.use(doc, {title: 'Contents'})
@@ -281,6 +286,7 @@ $ npm install remark-retext retext-english retext-indefinite-article
281286
var vfile = require('to-vfile')
282287
var report = require('vfile-reporter')
283288
var markdown = require('remark-parse')
289+
var slug = require('remark-slug')
284290
var toc = require('remark-toc')
285291
+var remark2retext = require('remark-retext')
286292
+var english = require('retext-english')
@@ -297,6 +303,7 @@ $ npm install remark-retext retext-english retext-indefinite-article
297303
+ .use(english)
298304
+ .use(indefiniteArticle)
299305
+ )
306+
.use(slug)
300307
.use(toc)
301308
.use(remark2rehype)
302309
.use(doc, {title: 'Contents'})
@@ -355,6 +362,8 @@ If you haven’t already, check out the other [guides][]!
355362

356363
[node]: https://nodejs.org
357364

365+
[slug]: https://github.com/remarkjs/remark-slug
366+
358367
[toc]: https://github.com/remarkjs/remark-toc
359368

360369
[document]: https://github.com/rehypejs/rehype-document

0 commit comments

Comments
 (0)