Skip to content

Commit 2834cf0

Browse files
committed
Update example in readme.md
1 parent 03e4ff2 commit 2834cf0

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

readme.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,34 +13,24 @@ npm install unist-util-inspect
1313
## Usage
1414

1515
```javascript
16-
var retext = require('retext');
16+
var unified = require('unified');
1717
var inspect = require('unist-util-inspect');
18+
var parse = require('rehype-parse');
1819

19-
retext().use(plugin).processSync('Some simple text.');
20+
var tree = unified().use(parse).parse('<h2>Hello, world!</h2>');
2021

21-
function plugin() {
22-
return transformer;
23-
function transformer(tree) {
24-
console.log(inspect(tree));
25-
}
26-
}
22+
console.log(inspect(tree));
2723
```
2824

2925
Yields:
3026

3127
```text
32-
RootNode[1] (1:1-1:18, 0-17)
33-
└─ ParagraphNode[1] (1:1-1:18, 0-17)
34-
└─ SentenceNode[6] (1:1-1:18, 0-17)
35-
├─ WordNode[1] (1:1-1:5, 0-4)
36-
│ └─ TextNode: "Some" (1:1-1:5, 0-4)
37-
├─ WhiteSpaceNode: " " (1:5-1:6, 4-5)
38-
├─ WordNode[1] (1:6-1:12, 5-11)
39-
│ └─ TextNode: "simple" (1:6-1:12, 5-11)
40-
├─ WhiteSpaceNode: " " (1:12-1:13, 11-12)
41-
├─ WordNode[1] (1:13-1:17, 12-16)
42-
│ └─ TextNode: "text" (1:13-1:17, 12-16)
43-
└─ PunctuationNode: "." (1:17-1:18, 16-17)
28+
root[1] (1:1-1:23, 0-22) [data={"quirksMode":true}]
29+
└─ element[2] [tagName="html"]
30+
├─ element[0] [tagName="head"]
31+
└─ element[1] [tagName="body"]
32+
└─ element[1] (1:1-1:23, 0-22) [tagName="h2"]
33+
└─ text: "Hello, world!" (1:5-1:18, 4-17)
4434
```
4535

4636
## API

0 commit comments

Comments
 (0)