Skip to content

Commit bbf3cfd

Browse files
YoranBrondsemabantic
authored andcommitted
docs(grammarly): DOC - Add section about disabling Grammarly (#490)
* Add blurb about Grammarly. * Remove unwanted documentation.
1 parent 059fd66 commit bbf3cfd

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Mobiledoc Kit
1+
# Mobiledoc Kit
22

33
[![Sauce Test Status](https://saucelabs.com/browser-matrix/mobiledoc-kit.svg)](https://saucelabs.com/u/mobiledoc-kit)
44

@@ -287,11 +287,16 @@ Parser hooks are called with three arguments:
287287
Note that you *must* call `nodeFinished` to stop a DOM node from being
288288
parsed by the next plugin or the default parser.
289289

290-
### Contributing
290+
## Caveats
291+
292+
### Mobiledoc-kit and the Grammarly extension
293+
`mobiledoc-kit` and the [Grammarly extension](https://www.grammarly.com/) do not play well together (see [issue 422](https://github.com/bustlelabs/mobiledoc-kit/issues/422)). Until this is resolved, you can avoid any such problems by disabling Grammarly for the `mobiledoc-kit` instances on your page. To do this, add the `data-gram="false"` attribute to the `mobiledoc-kit` main DOM element.
294+
295+
## Contributing
291296

292297
Fork the repo, write a test, make a change, open a PR.
293298

294-
#### Tests
299+
### Tests
295300

296301
Install npm and bower:
297302

@@ -312,7 +317,7 @@ Or run headless tests via testem:
312317

313318
Tests in CI are run at Travis via Saucelabs (see the `test:ci` npm script).
314319

315-
#### Demo
320+
### Demo
316321

317322
There is a demo app that uses the Mobiledoc kit via the [ember-mobiledoc-editor](https://github.com/bustlelabs/ember-mobiledoc-editor)
318323
in `demo/`. To run the demo:
@@ -322,18 +327,18 @@ in `demo/`. To run the demo:
322327
* visit http://localhost:4200/
323328

324329

325-
#### Getting Help
330+
### Getting Help
326331

327332
If you notice a bug or have a feature request please [open an issue on github](https://github.com/bustlelabs/mobiledoc-kit/issues).
328333
If you have a question about usage you can post in the [gitter channel](https://gitter.im/bustlelabs/mobiledoc-kit) or on StackOverflow using the [`mobiledoc-kit` tag](http://stackoverflow.com/questions/tagged/mobiledoc-kit).
329334

330-
#### Releasing
335+
### Releasing
331336

332337
* Use `np` (`npm install -g np`)
333338
* `np <version>` (e.g. `np 0.12.0`)
334339
* `git push <origin> --tags`
335340

336-
#### Deploy the demo
341+
### Deploy the demo
337342

338343
The demo website is hosted at github pages. To publish a new version:
339344

0 commit comments

Comments
 (0)