Skip to content

Commit e234794

Browse files
committed
Refactor readme with references and definitions
1 parent 3234a8a commit e234794

File tree

1 file changed

+60
-18
lines changed

1 file changed

+60
-18
lines changed

readme.md

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
# mdast-util-to-nlcst [![Build Status](https://img.shields.io/travis/wooorm/mdast-util-to-nlcst.svg)](https://travis-ci.org/wooorm/mdast-util-to-nlcst) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/mdast-util-to-nlcst.svg)](https://codecov.io/github/wooorm/mdast-util-to-nlcst)
1+
# mdast-util-to-nlcst [![Build Status][travis-badge]][travis] [![Coverage Status][coverage-badge]][coverage]
22

3-
[**mdast**](https://github.com/wooorm/mdast) utility to transform markdown
4-
into [**nlcst**](https://github.com/wooorm/nlcst), while keeping location
3+
[**mdast**][mdast] utility to transform markdown
4+
into [**nlcst**][nlcst], while keeping location
55
information intact.
66

77
In plain English: this enables natural-language tooling to read markdown as
88
input.
99

1010
> **Note** You probably want to use
11-
> [remark-retext](https://github.com/wooorm/remark-retext).
11+
> [remark-retext][].
1212
1313
## Installation
1414

15-
[npm](https://docs.npmjs.com/cli/install):
15+
[npm][npm-install]:
1616

1717
```bash
1818
npm install mdast-util-to-nlcst
1919
```
2020

21-
**mdast-util-to-nlcst** is also available for [duo](http://duojs.org/#getting-started),
22-
and as an AMD, CommonJS, and globals module, [uncompressed and compressed](https://github.com/wooorm/mdast-util-to-nlcst/releases).
21+
**mdast-util-to-nlcst** is also available for [duo][],
22+
and as an AMD, CommonJS, and globals module,
23+
[uncompressed and compressed][releases].
2324

2425
## Usage
2526

@@ -60,27 +61,68 @@ remark().process('Some *foo*s-_ball_.', function (err, file) {
6061

6162
### toNLCST(file, Parser | parser)
6263

63-
Transform a by [**remark**](https://github.com/wooorm/remark) processed
64-
[**virtual file**](https://github.com/wooorm/vfile) into an
65-
[NLCST](https://github.com/wooorm/nlcst) tree for
66-
[**retext**](https://github.com/wooorm/retext).
64+
Transform a by [**remark**][remark] processed
65+
[**virtual file**][vfile] into an
66+
[NLCST][nlcst] tree for
67+
[**retext**][retext].
6768

6869
Parameters:
6970

7071
* `file` (`File`)
71-
[Virtual file](https://github.com/wooorm/vfile), must be passed through
72-
[`parse()`](https://github.com/wooorm/remark/blob/master/doc/remark.3.md#remarkparsefile-options).
72+
[Virtual file][vfile], must be passed through
73+
[`parse()`][remark-parse].
7374

7475
* `parser` (`Function` or `Parser`, optional)
7576
— You can pass the (constructor of) an NLCST parser, such as
76-
[**parse-english**](https://github.com/wooorm/parse-english),
77-
[**parse-dutch**](https://github.com/wooorm/parse-dutch), or
78-
[**parse-latin**](https://github.com/wooorm/parse-latin).
77+
[**parse-english**][parse-english], [**parse-dutch**][parse-dutch],
78+
or [**parse-latin**][parse-latin].
7979

8080
Returns:
8181

82-
[`NLCSTNode`](https://github.com/wooorm/nlcst).
82+
[`NLCSTNode`][nlcst-node].
8383

8484
## License
8585

86-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
86+
[MIT][license] © [Titus Wormer][home]
87+
88+
<!-- Definitions -->
89+
90+
[travis-badge]: https://img.shields.io/travis/wooorm/mdast-util-to-nlcst.svg
91+
92+
[travis]: https://travis-ci.org/wooorm/mdast-util-to-nlcst
93+
94+
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-to-nlcst.svg
95+
96+
[coverage]: https://codecov.io/github/wooorm/mdast-util-to-nlcst
97+
98+
[vfile]: https://github.com/wooorm/vfile
99+
100+
[remark]: https://github.com/wooorm/remark
101+
102+
[retext]: https://github.com/wooorm/retext
103+
104+
[mdast]: https://github.com/wooorm/mdast
105+
106+
[nlcst]: https://github.com/wooorm/nlcst
107+
108+
[remark-retext]: https://github.com/wooorm/remark-retext
109+
110+
[npm-install]: https://docs.npmjs.com/cli/install
111+
112+
[duo]: http://duojs.org/#getting-started
113+
114+
[releases]: https://github.com/wooorm/mdast-util-to-nlcst/releases
115+
116+
[remark-parse]: https://github.com/wooorm/remark/blob/master/doc/remark.3.md#remarkparsefile-options
117+
118+
[nlcst-node]: https://github.com/wooorm/nlcst
119+
120+
[parse-english]: https://github.com/wooorm/parse-english
121+
122+
[parse-dutch]: https://github.com/wooorm/parse-dutch
123+
124+
[parse-latin]: https://github.com/wooorm/parse-latin
125+
126+
[license]: LICENSE
127+
128+
[home]: http://wooorm.com

0 commit comments

Comments
 (0)