Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

69 lines (46 sloc) 2.318 kB

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".

Compatability

WYMeditor is compatible with:

  • IE 6+
  • Firefox 2+
  • Opera 9.5+
  • Safari 3.0+
  • Google Chrome

Quick Start

Download the latest release from WYMeditor.org or build it yourself using make (recommended). Then include jQuery and the WYMeditor source:

<script type="text/javascript" src="/jquery/jquery.js"></script>
<script type="text/javascript" src="/wymeditor/jquery.wymeditor.min.js"></script>

WYMeditor should work with jQuery 1.2.x and up, although using a later jQuery version is preferred.

Now, prepare yourself a textarea:

<textarea class="wymeditor"><p>Hello, World!</p></textarea>
<input type="submit" class="wymupdate" />

Make sure to include the wymupdate class on your submit buttons.

On ready:

<script>
  $(document).ready(function() {
    $('.wymeditor').wymeditor();
  });
</script>

More examples can be found here or in your local examples directory.

Building WYMeditor

To build WYMeditor you need to have make and the UglifyJS module for Node.js installed. To install UglifyJS using NPM runt the following: npm install -g uglify-js

Running make in the terminal will build WYMeditor for distribution inside the dist catalog, which will be created if if does not already exist.

Running make wymeditor will only merge and minify the the WYMeditor source without packaging it for distribution.

Contributing

Read more on contributing.

Copyright

Copyright (c) 2005 - 2011 Jean-Francois Hovinne, Dual licensed under the MIT (MIT-license.txt) and GPL (GPL-license.txt) licenses.

Jump to Line
Something went wrong with that request. Please try again.