Skip to content

Commit

Permalink
updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maxwondercorn committed Dec 6, 2018
1 parent 521f318 commit ca9bdfc
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ This dictionary merges in the `en_US` Hunspell [dictionary](http://wordlist.sour
```sh
npm add ember-dictionary
```

Note: Some `retext` plugins have dependencies that require Node v8. Specifically, the `remark-lint-no-dead-urls` plugin.

## Configuration file

To use the dictionary, add it to `.remarkrc.js` file with the appropriate configuration options

```js
// .remarkrc.js
/* eslint-env node */
const unified = require("unified");
const read = require("fs").readFileSync;
Expand Down Expand Up @@ -46,7 +48,8 @@ exports.plugins = [
],
"remark-preset-lint-consistent",
"remark-preset-lint-recommended",
["remark-lint-list-item-indent", "space"]
["remark-lint-list-item-indent", "space"],
"remark-lint-no-dead-urls"
];
```

Expand Down

0 comments on commit ca9bdfc

Please sign in to comment.