You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##Mobiledoc Kit
1
+
# Mobiledoc Kit
2
2
3
3
[](https://saucelabs.com/u/mobiledoc-kit)
4
4
@@ -287,11 +287,16 @@ Parser hooks are called with three arguments:
287
287
Note that you *must* call `nodeFinished` to stop a DOM node from being
288
288
parsed by the next plugin or the default parser.
289
289
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
291
296
292
297
Fork the repo, write a test, make a change, open a PR.
293
298
294
-
####Tests
299
+
### Tests
295
300
296
301
Install npm and bower:
297
302
@@ -312,7 +317,7 @@ Or run headless tests via testem:
312
317
313
318
Tests in CI are run at Travis via Saucelabs (see the `test:ci` npm script).
314
319
315
-
####Demo
320
+
### Demo
316
321
317
322
There is a demo app that uses the Mobiledoc kit via the [ember-mobiledoc-editor](https://github.com/bustlelabs/ember-mobiledoc-editor)
318
323
in `demo/`. To run the demo:
@@ -322,18 +327,18 @@ in `demo/`. To run the demo:
322
327
* visit http://localhost:4200/
323
328
324
329
325
-
####Getting Help
330
+
### Getting Help
326
331
327
332
If you notice a bug or have a feature request please [open an issue on github](https://github.com/bustlelabs/mobiledoc-kit/issues).
328
333
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).
329
334
330
-
####Releasing
335
+
### Releasing
331
336
332
337
* Use `np` (`npm install -g np`)
333
338
*`np <version>` (e.g. `np 0.12.0`)
334
339
*`git push <origin> --tags`
335
340
336
-
####Deploy the demo
341
+
### Deploy the demo
337
342
338
343
The demo website is hosted at github pages. To publish a new version:
0 commit comments