Skip to content

Commit a74a9c5

Browse files
committed
Refactor readme with references and definitions
1 parent 8877777 commit a74a9c5

File tree

1 file changed

+29
-19
lines changed

1 file changed

+29
-19
lines changed

readme.md

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

3-
Markdown heading as ranges in [**mdast**](https://github.com/wooorm/mdast).
3+
Markdown heading as ranges in [**mdast**][mdast].
44

55
## Installation
66

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

99
```bash
1010
npm install mdast-util-heading-range
1111
```
1212

13-
**mdast-util-heading-range** is also available for [duo](http://duojs.org/#getting-started),
14-
and as an AMD, CommonJS, and globals module, [uncompressed and
15-
compressed](https://github.com/wooorm/mdast-util-heading-range/releases).
16-
17-
## Table of Contents
18-
19-
* [Usage](#usage)
20-
21-
* [API](#api)
22-
23-
* [heading(test, onrun)](#headingtest-onrun)
24-
25-
* [function onrun(start, nodes, end?, scope)](#function-onrunstart-nodes-end-scope)
26-
27-
* [License](#license)
13+
**mdast-util-heading-range** is also available for [duo][],
14+
and as an AMD, CommonJS, and globals module,
15+
[uncompressed and compressed][releases].
2816

2917
## Usage
3018

@@ -125,4 +113,26 @@ or lower depth, or the end of the document.
125113

126114
## License
127115

128-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
116+
[MIT][license] © [Titus Wormer][home]
117+
118+
<!-- Definitions -->
119+
120+
[travis-badge]: https://img.shields.io/travis/wooorm/mdast-util-heading-range.svg
121+
122+
[travis]: https://travis-ci.org/wooorm/mdast-util-heading-range
123+
124+
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-heading-range.svg
125+
126+
[coverage]: https://codecov.io/github/wooorm/mdast-util-heading-range
127+
128+
[mdast]: https://github.com/wooorm/mdast
129+
130+
[npm-install]: https://docs.npmjs.com/cli/install
131+
132+
[duo]: http://duojs.org/#getting-started
133+
134+
[releases]: https://github.com/wooorm/mdast-util-heading-range/releases
135+
136+
[license]: LICENSE
137+
138+
[home]: http://wooorm.com

0 commit comments

Comments
 (0)