itsawysiwyg v0.1.5

ItsaWYSIWYG

A very tiny, highly configurable javascript WYSIWYG editor with zero dependencies.

Getting Started

All you need to get started is to instantiate the WYSIWYG, it takes 1 parameter which is the selector of the editable content area.

JS

// You can also use it like:
// new Wysiwyg('#anid');
// new Wysiwyg('.aclass');
// new Wysiwyg('atag');

new Wysiwyg('.editable');

HTML

Note that within the div.editable there is another div, this child div must wrap all content, this is to be changed by 1.0.0

<div class="editable">
    <div>This is just some simple text</div>
</div>

Prerequisites

If you would like to build form source then the following prerequisites are required

NPM

Installing

A step by step series of examples that tell you have to get a development env running

Including in your own project

$ npm install itsawysiwyg

Or optionally if you use Yarn

$ yarn add itsawysiwyg

Running the demo

$ git clone https://github.com/1e4/itsawysiwyg
$ cd itsawysiwyg
$ yarn
$ yarn run hot

This uses webpacks built in web server, head over to the URL it lists, by default it is http://localhost:8080

Running the tests

There are no tests sorry :(

Built With

• Font Awesome - They provide the optional icons for the toolbar
• Javascript - Javascript ES6, every feature by default is completely native to the browser, there are no 3rd party Javascript libraries included
• SCSS - We use SCSS for the demo application

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ian Milliken - Initial work - Twitter

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details