|
1 |
| -# unist-util-inspect [](https://travis-ci.org/wooorm/unist-util-inspect) [](https://codecov.io/github/wooorm/unist-util-inspect?branch=master) |
| 1 | +# unist-util-inspect [![Build Status][build-badge]][build-page] [![Coverage Status][coverage-badge]][coverage-page] |
2 | 2 |
|
3 |
| -[Unist](https://github.com/wooorm/unist) node inspector. |
| 3 | +[Unist][] node inspector. |
4 | 4 |
|
5 | 5 | ## Installation
|
6 | 6 |
|
7 |
| -[npm](https://docs.npmjs.com/cli/install): |
| 7 | +[npm][]: |
8 | 8 |
|
9 | 9 | ```bash
|
10 | 10 | npm install unist-util-inspect
|
11 | 11 | ```
|
12 | 12 |
|
13 | 13 | **unist-util-inspect** is also available as an AMD, CommonJS, and
|
14 |
| -globals module, [uncompressed and compressed](https://github.com/wooorm/unist-util-inspect/releases). |
| 14 | +globals module, [uncompressed and compressed][releases]. |
15 | 15 |
|
16 | 16 | ## Usage
|
17 | 17 |
|
@@ -45,24 +45,46 @@ RootNode[1] (1:1-1:18, 0-17)
|
45 | 45 |
|
46 | 46 | ## API
|
47 | 47 |
|
48 |
| -### inspect([node](https://github.com/wooorm/unist#unist-nodes)) |
| 48 | +### `inspect(node)` |
49 | 49 |
|
50 |
| -By default, color support is enabled on node and turned off anywhere else. |
| 50 | +By default, color support is enabled on Node.js and turned off anywhere else. |
51 | 51 | See below on how to change that.
|
52 | 52 |
|
53 | 53 | **Parameters**
|
54 | 54 |
|
55 |
| -* `node` ([`Node`](https://github.com/wooorm/unist#unist-nodes)). |
| 55 | +* `node` ([`Node`][node]). |
56 | 56 |
|
57 | 57 | **Returns** `string` — String representing `node`.
|
58 | 58 |
|
59 |
| -### inspect.\\<style>\[.\\<style>...](node) |
| 59 | +### `inspect.<style>[.<style>...](node)` |
60 | 60 |
|
61 |
| -Where `style` is either `color` or `noColor`. |
| 61 | +Where `<style>` is either `color` or `noColor`. |
62 | 62 |
|
63 | 63 | To explicitly add or remove ANSI sequences, use either `inspect.color(node)`
|
64 | 64 | or `inspect.noColor(node)`.
|
65 | 65 |
|
66 | 66 | ## License
|
67 | 67 |
|
68 |
| -[MIT](LICENSE) © [Titus Wormer](http://wooorm.com) |
| 68 | +[MIT][license] © [Titus Wormer][author] |
| 69 | + |
| 70 | +<!-- Definition --> |
| 71 | + |
| 72 | +[build-badge]: https://img.shields.io/travis/wooorm/unist-util-inspect.svg |
| 73 | + |
| 74 | +[build-page]: https://travis-ci.org/wooorm/unist-util-inspect |
| 75 | + |
| 76 | +[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/unist-util-inspect.svg |
| 77 | + |
| 78 | +[coverage-page]: https://codecov.io/github/wooorm/unist-util-inspect?branch=master |
| 79 | + |
| 80 | +[unist]: https://github.com/wooorm/unist |
| 81 | + |
| 82 | +[npm]: https://docs.npmjs.com/cli/install |
| 83 | + |
| 84 | +[releases]: https://github.com/wooorm/unist-util-inspect/releases |
| 85 | + |
| 86 | +[node]: https://github.com/wooorm/unist#unist-nodes |
| 87 | + |
| 88 | +[license]: LICENSE |
| 89 | + |
| 90 | +[author]: http://wooorm.com |
0 commit comments