Skip to content

Commit

Permalink
Refactor prose
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed May 25, 2019
1 parent 6a27a39 commit 4dcbc94
Showing 1 changed file with 43 additions and 21 deletions.
64 changes: 43 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,26 @@
# hast-util-interactive [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Chat][chat-badge]][chat]
# hast-util-interactive

Check whether a [HAST node][hast] is [**interactive**][spec].
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

## Installation
Check whether a [**hast**][hast] node is [*interactive*][spec].

## Install

[npm][]:

```bash
```sh
npm install hast-util-interactive
```

## Usage

```javascript
```js
var interactive = require('hast-util-interactive')

interactive({
Expand Down Expand Up @@ -47,53 +55,67 @@ interactive({

###### Returns

`boolean` — Whether `node` is an [`Element`][element] categorised
as [**interactive**][spec].
`boolean` — Whether `node` is an [`Element`][element] categorised as
[*interactive*][spec].

## Contribute

See [`contributing.md` in `syntax-tree/hast`][contributing] for ways to get
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
started.
See [`support.md`][support] for ways to get help.

This organisation has a [Code of Conduct][coc]. By interacting with this
repository, organisation, or community you agree to abide by its terms.
This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definition -->

[build-badge]: https://img.shields.io/travis/syntax-tree/hast-util-interactive.svg
[build-badge]: https://img.shields.io/travis/syntax-tree/unist-util-assert.svg

[build]: https://travis-ci.org/syntax-tree/unist-util-assert

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-assert.svg

[coverage]: https://codecov.io/github/syntax-tree/unist-util-assert

[downloads-badge]: https://img.shields.io/npm/dm/unist-util-assert.svg

[downloads]: https://www.npmjs.com/package/unist-util-assert

[build]: https://travis-ci.org/syntax-tree/hast-util-interactive
[size-badge]: https://img.shields.io/bundlephobia/minzip/unist-util-assert.svg

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-interactive.svg
[size]: https://bundlephobia.com/result?p=unist-util-assert

[coverage]: https://codecov.io/github/syntax-tree/hast-util-interactive
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[downloads-badge]: https://img.shields.io/npm/dm/hast-util-interactive.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[downloads]: https://www.npmjs.com/package/hast-util-interactive
[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg

[chat]: https://spectrum.chat/unified/rehype
[chat]: https://spectrum.chat/unified/syntax-tree

[npm]: https://docs.npmjs.com/cli/install

[license]: license

[author]: https://wooorm.com

[contributing]: https://github.com/syntax-tree/.github/blob/master/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/master/support.md

[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md

[hast]: https://github.com/syntax-tree/hast

[node]: https://github.com/syntax-tree/unist#node

[element]: https://github.com/syntax-tree/hast#element

[spec]: https://html.spec.whatwg.org/#interactive-content

[contributing]: https://github.com/syntax-tree/hast/blob/master/contributing.md

[coc]: https://github.com/syntax-tree/hast/blob/master/code-of-conduct.md

0 comments on commit 4dcbc94

Please sign in to comment.