Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 3.49 KB

README.md

File metadata and controls

98 lines (65 loc) · 3.49 KB

Trumbowyg logo

CDNJS Downloads Version on npm Version on bower Licence

Supporting Trumbowyg

Trumbowyg is an MIT-licensed open source project and completely free to use.

However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support it's ongoing development by being a backer or a sponsor:

Sponsors

Gold

avot®       AppSeed

Become a Sponsor


Introduction

Trumbowyg is a simple and lightweight WYSIWYG editor, weight only 20kB minifed (8kB gzip) for faster page loading.

Visit presentation page: http://alex-d.github.io/Trumbowyg/

Info for the nojquery branch

The "nojquery" branch does not require jquery. However it use features from ES6 (next generation javascript) so your webbrowser might not support it. You could try using various polyfills for fetch, promise and interator. Note that the bransh is expreimental so some features might not work and are prone to errors. Also plugins do not work (yet). The build tools have been changed to webpack so you might need to install it. As for now, this is how you invoke Trumbowyg:

var element = document.getElementById("sometextarea");
trumbowyg.trumbowyg.init(element, options, params);

So it is different from the jquery version. Note that "trumbowyg.trumbowyg" is not a typo.

Documentation

All you need to know about Trumbowyg is here: http://alex-d.github.io/Trumbowyg/documentation/ (or even on the home)

Contribution

You can contribute to Trumbowyg with translations in languages you know. Thanks to node you can improve core script, style or icons easily.

First, fork and clone the repository

cd Trumbowyg # to go into the project's root directory
npm install # to install development dependencies
npm run build # to build the project

Stay in touch

For the latest release and announcements, follow on Twitter: @AlexandreDemode

License

This project is under MIT license.