From 64d41f392c1772eba0dd9c73dbb09a782d1d00f1 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sat, 17 Jun 2017 14:37:07 +0200 Subject: [PATCH] Update example in `readme.md` --- readme.md | 45 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 8cfa984..2ebe6f8 100644 --- a/readme.md +++ b/readme.md @@ -15,20 +15,49 @@ npm install remark-slug ## Usage -```javascript -var slug = require('./'); -var remark = require('remark'); -var html = require('remark-html'); +Say we have the following file, `example.md`: + +```markdown +# Lorem ipsum 😪 + +## dolor—sit—amet + +### consectetur & adipisicing -var file = remark().use(slug).use(html).processSync('# Foo bar'); +#### elit -console.log(String(file)); +##### elit +``` + +And our script, `example.js`, looks as follows: + +```javascript +var fs = require('fs'); +var unified = require('unified'); +var markdown = require('remark-parse'); +var slug = require('remark-slug'); +var remark2rehype = require('remark-rehype'); +var html = require('rehype-stringify'); + +unified() + .use(markdown) + .use(slug) + .use(remark2rehype) + .use(html) + .process(fs.readFileSync('example.md'), function (err, file) { + if (err) throw err; + console.log(String(file)); + }); ``` -Yields: +Now, running `node example` yields: ```html -

Foo bar

+

Lorem ipsum 😪

+

dolor—sit—amet

+

consectetur & adipisicing

+

elit

+
elit
``` ## API