Skip to content

Commit 22f132a

Browse files
committed
Refactor readme.md
1 parent f86478e commit 22f132a

File tree

1 file changed

+41
-16
lines changed

1 file changed

+41
-16
lines changed

readme.md

+41-16
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
# mdast-util-to-string [![Build Status](https://img.shields.io/travis/wooorm/mdast-mdast-util-to-string.svg)](https://travis-ci.org/wooorm/mdast-mdast-util-to-string) [![Coverage Status](https://img.shields.io/codecov/c/github/wooorm/mdast-mdast-util-to-string.svg)](https://codecov.io/github/wooorm/mdast-mdast-util-to-string)
1+
# mdast-util-to-string [![Build Status][travis-badge]][travis] [![Coverage Status][coverage-badge]][coverage]
22

3-
[**remark**](https://github.com/wooorm/remark) utility to get the plain text
4-
content of an [**mdast**](https://github.com/wooorm/mdast) node.
3+
[**remark**][remark] utility to get the plain text
4+
content of an [**mdast**][mdast] node.
55

66
## Installation
77

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

1010
```bash
1111
npm install mdast-util-to-string
1212
```
1313

14-
**mdast-util-to-string** is also available for
15-
[duo](http://duojs.org/#getting-started), and as an AMD, CommonJS, and globals
16-
module, [uncompressed and
17-
compressed](https://github.com/wooorm/mdast-util-to-string/releases).
14+
**mdast-util-to-string** is also available for [duo][],
15+
and as an AMD, CommonJS, and globals module,
16+
[uncompressed and compressed][releases].
1817

1918
## Usage
2019

@@ -38,23 +37,49 @@ toString(ast);
3837

3938
## API
4039

41-
### toString(node)
40+
### `toString(node)`
4241

4342
Get the text content of a node.
4443

45-
The algorithm checks the value of `node`, then its `alt`, and then
46-
its `title`, in that order. If no value is found, the algorithm checks
47-
the children of `node` and joins them (without spaces or newlines).
44+
The algorithm checks `value` of `node`, then `alt`, and finally `title`.
45+
If no value is found, the algorithm checks the children of `node` and
46+
joins them (without spaces or newlines).
4847

4948
> This is not a markdown to plain-text library.
5049
> Use [strip-markdown](https://github.com/wooorm/strip-markdown) for that.
5150
52-
Parameters:
51+
**Parameters**:
5352

54-
* `node` (`Node`) — [**mdast** node](https://github.com/wooorm/mdast#node);
53+
* `node` ([`Node`][mdast-node]).
5554

56-
Returns: `string` — text representation of `node`.
55+
**Returns**: `string` — text representation of `node`.
5756

5857
## License
5958

60-
[MIT](LICENSE) © [Titus Wormer](http://wooorm.com)
59+
[MIT][license] © [Titus Wormer][home]
60+
61+
<!-- Definitions -->
62+
63+
[travis-badge]: https://img.shields.io/travis/wooorm/mdast-util-to-string.svg
64+
65+
[travis]: https://travis-ci.org/wooorm/mdast-util-to-string
66+
67+
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/mdast-util-to-string.svg
68+
69+
[coverage]: https://codecov.io/github/wooorm/mdast-util-to-string
70+
71+
[remark]: https://github.com/wooorm/remark
72+
73+
[mdast]: https://github.com/wooorm/mdast
74+
75+
[mdast-node]: https://github.com/wooorm/mdast#node
76+
77+
[npm-install]: https://docs.npmjs.com/cli/install
78+
79+
[duo]: http://duojs.org/#getting-started
80+
81+
[releases]: https://github.com/wooorm/mdast-util-to-string/releases
82+
83+
[license]: LICENSE
84+
85+
[home]: http://wooorm.com

0 commit comments

Comments
 (0)