https://github.com/swilliams/jq-wysihat

A fork of wysihat to work with jQuery
https://github.com/swilliams/jq-wysihat

Last synced: 3 days ago
JSON representation

A fork of wysihat to work with jQuery

• Host: GitHub
• URL: https://github.com/swilliams/jq-wysihat
• Owner: swilliams
• License: other
• Fork: true (basecamp/wysihat)
• Created: 2010-07-14T15:13:41.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2011-10-21T02:20:06.000Z (about 13 years ago)
• Last Synced: 2024-08-02T05:11:06.240Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 873 KB
• Stars: 74
• Watchers: 3
• Forks: 13
• Open Issues: 9
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
WysiHat

=======

#### A WYSIWYG JavaScript framework

JQ-WysiHat is a WYSIWYG JavaScript framework that provides an extensible

foundation to design your own rich text editor. WysiHat stays out of your

way and leaves the UI design to you.

The original version of WysiHat was designed to run on Prototype. This fork of it was ported to run on jQuery (used against 1.4.2).

### Support platforms

JQ-WysiHat currently supports:

* Microsoft Internet Explorer for Windows, version 7.0

* Mozilla Firefox 3.0

* Apple Safari 4.0

* Google Chrome 4.0

### Dependencies

* jQuery 1.4.2 or later (http://jquery.com/) although older versions will probably work fine, they just haven't been tested.

## Documentation

Code is documented inline with PDoc (http://pdoc.org/).

The generated HTML documentation can be found on the `gh-pages` branch or viewed online at (http://josh.github.com/wysihat/).

### Examples

Several examples can be found under `examples/` to get you started.

The easiest way is to simply call:

    $('#myTextArea').wysihat();

This adds some commonly used buttons to the toolbar and gets you going.

### Downloading

Once I get closer to a 'stable' version I'll tag a release and add it here. However, in day to day use I haven't had any major troubles with it.

### Building from source

You can build the latest version of JQ-WysiHat from source by running

`rake` the root directory. The generated file will be saved to

`dist/jq-wysihat.js`. Ruby and the Rake gem are only required to build

the project from source. It is not required to run the code.

## Contributing

Check out the original WysiHat source with

    $ git clone git://github.com/josh/wysihat.git

And the fork with

    $ git clone git://github.com/swilliams/jq-wysihat.git

Then

    $ cd jq-wysihat

    $ git submodule init

    $ git submodule update

GitHub pull requests are welcome.

## License

jq-WysiHat is released under the MIT license.