|
1 |
| -# hast-util-interactive [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat] |
| 1 | +# hast-util-interactive |
2 | 2 |
|
3 |
| -Check whether a [HAST node][hast] is [**interactive**][spec]. |
| 3 | +[![Build][build-badge]][build] |
| 4 | +[![Coverage][coverage-badge]][coverage] |
| 5 | +[![Downloads][downloads-badge]][downloads] |
| 6 | +[![Size][size-badge]][size] |
| 7 | +[![Sponsors][sponsors-badge]][collective] |
| 8 | +[![Backers][backers-badge]][collective] |
| 9 | +[![Chat][chat-badge]][chat] |
4 | 10 |
|
5 |
| -## Installation |
| 11 | +Check whether a [**hast**][hast] node is [*interactive*][spec]. |
| 12 | + |
| 13 | +## Install |
6 | 14 |
|
7 | 15 | [npm][]:
|
8 | 16 |
|
9 |
| -```bash |
| 17 | +```sh |
10 | 18 | npm install hast-util-interactive
|
11 | 19 | ```
|
12 | 20 |
|
13 | 21 | ## Usage
|
14 | 22 |
|
15 |
| -```javascript |
| 23 | +```js |
16 | 24 | var interactive = require('hast-util-interactive')
|
17 | 25 |
|
18 | 26 | interactive({
|
@@ -47,53 +55,67 @@ interactive({
|
47 | 55 |
|
48 | 56 | ###### Returns
|
49 | 57 |
|
50 |
| -`boolean` — Whether `node` is an [`Element`][element] categorised |
51 |
| -as [**interactive**][spec]. |
| 58 | +`boolean` — Whether `node` is an [`Element`][element] categorised as |
| 59 | +[*interactive*][spec]. |
52 | 60 |
|
53 | 61 | ## Contribute
|
54 | 62 |
|
55 |
| -See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get |
| 63 | +See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get |
56 | 64 | started.
|
| 65 | +See [`support.md`][support] for ways to get help. |
57 | 66 |
|
58 |
| -This organisation has a [Code of Conduct][coc]. By interacting with this |
59 |
| -repository, organisation, or community you agree to abide by its terms. |
| 67 | +This project has a [Code of Conduct][coc]. |
| 68 | +By interacting with this repository, organisation, or community you agree to |
| 69 | +abide by its terms. |
60 | 70 |
|
61 | 71 | ## License
|
62 | 72 |
|
63 | 73 | [MIT][license] © [Titus Wormer][author]
|
64 | 74 |
|
65 | 75 | <!-- Definition -->
|
66 | 76 |
|
67 |
| -[build-badge]: https://img.shields.io/travis/syntax-tree/hast-util-interactive.svg |
| 77 | +[build-badge]: https://img.shields.io/travis/syntax-tree/unist-util-assert.svg |
| 78 | + |
| 79 | +[build]: https://travis-ci.org/syntax-tree/unist-util-assert |
| 80 | + |
| 81 | +[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-assert.svg |
| 82 | + |
| 83 | +[coverage]: https://codecov.io/github/syntax-tree/unist-util-assert |
| 84 | + |
| 85 | +[downloads-badge]: https://img.shields.io/npm/dm/unist-util-assert.svg |
| 86 | + |
| 87 | +[downloads]: https://www.npmjs.com/package/unist-util-assert |
68 | 88 |
|
69 |
| -[build]: https://travis-ci.org/syntax-tree/hast-util-interactive |
| 89 | +[size-badge]: https://img.shields.io/bundlephobia/minzip/unist-util-assert.svg |
70 | 90 |
|
71 |
| -[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-interactive.svg |
| 91 | +[size]: https://bundlephobia.com/result?p=unist-util-assert |
72 | 92 |
|
73 |
| -[coverage]: https://codecov.io/github/syntax-tree/hast-util-interactive |
| 93 | +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg |
74 | 94 |
|
75 |
| -[downloads-badge]: https://img.shields.io/npm/dm/hast-util-interactive.svg |
| 95 | +[backers-badge]: https://opencollective.com/unified/backers/badge.svg |
76 | 96 |
|
77 |
| -[downloads]: https://www.npmjs.com/package/hast-util-interactive |
| 97 | +[collective]: https://opencollective.com/unified |
78 | 98 |
|
79 | 99 | [chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg
|
80 | 100 |
|
81 |
| -[chat]: https://spectrum.chat/unified/rehype |
| 101 | +[chat]: https://spectrum.chat/unified/syntax-tree |
82 | 102 |
|
83 | 103 | [npm]: https://docs.npmjs.com/cli/install
|
84 | 104 |
|
85 | 105 | [license]: license
|
86 | 106 |
|
87 | 107 | [author]: https://wooorm.com
|
88 | 108 |
|
| 109 | +[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md |
| 110 | + |
| 111 | +[support]: https://github.com/syntax-tree/.github/blob/master/support.md |
| 112 | + |
| 113 | +[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md |
| 114 | + |
89 | 115 | [hast]: https://github.com/syntax-tree/hast
|
90 | 116 |
|
91 | 117 | [node]: https://github.com/syntax-tree/unist#node
|
92 | 118 |
|
93 | 119 | [element]: https://github.com/syntax-tree/hast#element
|
94 | 120 |
|
95 | 121 | [spec]: https://html.spec.whatwg.org/#interactive-content
|
96 |
| - |
97 |
| -[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md |
98 |
| - |
99 |
| -[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md |
|
0 commit comments