WYMeditor

Javascript WYSIWYM editor focused on clean, semantic markup

WYMeditor

WYMeditor is an open source web-based WYSIWYM editor with semantics and standards in mind. The WYM-part stands for "What You Mean" compared to the more common "What You See Is What You Get".

Why WYMeditor?

WYMeditor is different from the traditional editors because we are 100% focused on providing a simple experience for users that separates the content of their document from the presentation of that document. We focus on enforcing web standards and separating a document's structure (HTML) from its presentation (CSS). Your users won't know and shouldn't care about HTML, but when they need consistent, standards-compliant, clean content, they'll thank you.

There are lots of choices when it comes to a brower-based editor and many of them are stable, mature projects with thousands of users. If you need an editor that gives total control and flexibility to the user (not you, the developer), then WYMeditor is probably not for you. If you want an editor that you can customize to provide the specific capabilities your users need, and you want users focused on the structure of their content instead of tweaking fonts and margins, you should give WYMeditor a try.

We also fully support Internet Explorer 6, for those poor souls who have no choice.

Try It

Want to see what WYMeditor can do? Try the WYMeditor examples right now.

These examples run the bleeding edge code and give you a good idea of what WYMeditor can do.

Quick Start

  1. WYMeditor requires a version of jQuery between 1.2.6 and 1.9.1. First ensure that your page includes jQuery.

Note: If a version of jQuery at or above 1.8.0 is used, WYMeditor also requires jQuery Migrate. Ensure that your page also includes jQuery Migrate after jQuery is included.

  1. Download the Version 1.0.0b5 archive and extract the contents to a folder in your project.

  2. Include the wymeditor/jquery.wymeditor.min.js file on your page. This file will pull in anything else that's required.

  3. Now use the wymeditor() function to select one of your textarea elements and turn it in to a WYMeditor instance. eg. if you have a textarea with the class my-wymeditor:

    $('.my-wymeditor').wymeditor();

Note: You'll probably want to do this initialization inside a $(document).ready() block.

  1. If you'd like to receive the valid HTML your editor produce on form submission, just add the class wymupdate to your submit button.

  2. ???

  3. Profit!

More examples with different plugins and configuration options can be found in your examples directory.

Compatibility

WYMeditor is compatible with:

Full Documentation

Check out or detailed documentation at: wymeditor.readthedocs.org.

More Info