Skip to content

Commit 7dd568e

Browse files
committed
Refactor docs
1 parent 5d84a35 commit 7dd568e

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

readme.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
# mdast-util-to-nlcst [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
22

3-
<!--lint disable heading-increment list-item-spacing-->
4-
53
Transform [MDAST][] to [NLCST][].
64

75
> **Note** You probably want to use [remark-retext][].
86
97
## Installation
108

11-
[npm][npm-install]:
9+
[npm][]:
1210

1311
```bash
1412
npm install mdast-util-to-nlcst
@@ -24,22 +22,16 @@ var inspect = require('unist-util-inspect');
2422
var English = require('parse-english');
2523
var remark = require('remark');
2624
var vfile = require('vfile');
27-
```
2825

29-
Process:
30-
31-
```javascript
3226
var file = vfile('Some *foo*sball.');
3327
var tree = remark().parse(file);
34-
```
35-
36-
Stringify:
3728

38-
```javascript
3929
var nlcst = toNLCST(tree, file, English);
30+
31+
console.log(inspect(nlcst));
4032
```
4133

42-
Which, when inspecting, yields:
34+
Yields:
4335

4436
```txt
4537
RootNode[1] (1:1-1:17, 0-16)
@@ -89,7 +81,7 @@ into an [NLCST][nlcst] tree.
8981

9082
[codecov]: https://codecov.io/github/wooorm/mdast-util-to-nlcst
9183

92-
[npm-install]: https://docs.npmjs.com/cli/install
84+
[npm]: https://docs.npmjs.com/cli/install
9385

9486
[license]: LICENSE
9587

0 commit comments

Comments
 (0)