search

bergie / hallo

Simple rich text editor (contentEditable) for jQuery UI
http://hallojs.org/
MIT License
2.43k stars 316 forks source link

README.md documentation confusing #233

Open rickdog opened 9 years ago

rickdog commented 9 years ago

doc says:

Hallo itself only makes the selected DOM elements editable and doesn't provide any formatting tools. Formatting is accomplished by loading plugins when initializing Hallo. Even simple things like bold and italic are plugins:

jQuery('.editable').hallo({
  plugins: {
    'halloformat': {}
  }
});

but when I invoke jQuery('p').hallo({editable: true}); it only sets contenteditble="true", it doesn't add class="editable". I'm guessing that the user must add class="editable", it is not added by hallo. The documentation fails to mention this - so the examples using jQuery('.editable').hallo(...) are confusing, not knowing that.