Skip to content

Commit

Permalink
docs(grammarly): DOC - Add section about disabling Grammarly (#490)
Browse files Browse the repository at this point in the history
* Add blurb about Grammarly.

* Remove unwanted documentation.
  • Loading branch information
YoranBrondsema authored and bantic committed Sep 8, 2016
1 parent 059fd66 commit bbf3cfd
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Mobiledoc Kit
# Mobiledoc Kit

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

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

### Contributing
## Caveats

### Mobiledoc-kit and the Grammarly extension
`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.

## Contributing

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

#### Tests
### Tests

Install npm and bower:

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

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

#### Demo
### Demo

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


#### Getting Help
### Getting Help

If you notice a bug or have a feature request please [open an issue on github](https://github.com/bustlelabs/mobiledoc-kit/issues).
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).

#### Releasing
### Releasing

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

#### Deploy the demo
### Deploy the demo

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

Expand Down

0 comments on commit bbf3cfd

Please sign in to comment.