Skip to content

Commit

Permalink
Refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Nov 13, 2016
1 parent 157097d commit a8910c9
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,19 @@ Transform [MDAST][] to [HAST][].

## Installation

[npm][npm-install]:
[npm][]:

```bash
npm install mdast-util-to-hast
```

## Usage

Dependencies:

```javascript
var inspect = require('unist-util-inspect');
var remark = require('remark');
var toHAST = require('mdast-util-to-hast');
```

Transform:

```javascript
var hast = toHAST(remark().parse('## Hello **World**!'));
console.log(inspect(hast));
```
Expand Down Expand Up @@ -84,7 +78,7 @@ default: `false`). Only do this when compiling later with

[codecov]: https://codecov.io/github/wooorm/mdast-util-to-hast

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

[license]: LICENSE

Expand Down

0 comments on commit a8910c9

Please sign in to comment.