Skip to content

Latest commit

 

History

History
97 lines (64 loc) · 2.81 KB

README.md

File metadata and controls

97 lines (64 loc) · 2.81 KB

cb-ember-mobiledoc-editor

CI

A simple wrapper for MobileDoc. Heavily inspired by https://github.com/bustle/ember-mobiledoc-editor but using modern Ember techniques.

Compatibility

  • Ember.js v4.0.0 or above
  • Embroider or ember-auto-import v2

Demo

https://crunchybananas.github.io/cb-ember-mobiledoc-editor/

Installation

ember install cb-ember-mobiledoc-editor

Linking Library for Development

To link this package locally for development, execute the following, where <project-root> is the root of the project using this library as a dependency:

cd packages/cb-ember-mobiledoc-editor/
npm link

cd <project-root>
npm link cb-ember-mobiledoc-editor

To unlink this project:

cd <project-root>
npm unlink --no-save cb-ember-mobiledoc-editor

cd packages/cb-ember-mobiledoc-editor/
npm unlink

Note that after unlinking, you may need to delete node_modules and reinstall the dependencies. Sometimes simply reinstalling the dependencies after relinking doesn't work.

Linking for Test App

The test app isn't automatically linked to the local repo. To run the test app on the local codebase it must also be linked in the same fashion as above:

cd packages/cb-ember-mobiledoc-editor/
npm link

cd ../test-app/
npm link cb-ember-mobiledoc-editor

Note that you may need to delete node_modules in the test-app directory before linking and then reinstall the dependencies for the link to work.

Why this addon?

We love this addon and have many projects using the official addon provided by Bustle. Over the past few years that addon has not received as much attention and has prevented some projects of our from moving to Ember 4.0+. The goal with this addon is to provide the smallest amount of custom code and to rely on the native implementation as much as possible.

Development

Run ember serve from packages/test-app and navigate to http://localhost:4200 in your browser.

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.