trumbowyg/README.md

A lightweight WYSIWYG editor

<p align="center">
  <a href="http://alex-d.github.io/Trumbowyg/"><img src="banner.jpg" alt="" /></a>
</p>

<p align="center">
  <a href="https://bundlephobia.com/result?p=trumbowyg"><img src="https://img.shields.io/bundlephobia/minzip/trumbowyg.svg?style=for-the-badge" alt="Downloads" /></a>
  <a href="https://www.npmjs.com/package/trumbowyg"><img src="https://img.shields.io/npm/dm/trumbowyg.svg?color=blue&label=npm%20downloads&style=for-the-badge" alt="Downloads" /></a>
  <a href="https://github.com/Alex-D/Trumbowyg/blob/develop/LICENSE"><img src="https://img.shields.io/npm/l/trumbowyg.svg?color=blue&style=for-the-badge" alt="Licence" /></a>
  <br>
  <a href="https://www.npmjs.com/package/trumbowyg"><img src="https://img.shields.io/npm/v/trumbowyg.svg?color=blue&style=for-the-badge" alt="Version on npm" /></a>
  <a href="https://cdnjs.com/libraries/Trumbowyg"><img src="https://img.shields.io/cdnjs/v/Trumbowyg.svg?color=blue&style=for-the-badge" alt="CDNJS" /></a>
  <img src="https://img.shields.io/bower/v/trumbowyg.svg?color=blue&style=for-the-badge" alt="Version on bower" />
</p>


<h2 align="center">Supporting Trumbowyg</h2>

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 its ongoing development by being a backer or a sponsor:

- [Become a backer or sponsor on Patreon](https://www.patreon.com/alexandredemode)
- [One-time donation via PayPal](https://www.paypal.me/demodealexandre/20eur)

<h3 align="center">Sponsors</h3>

<h4 align="center">Gold</h4>

<p align="center">
    <a href="https://www.premirus.com/?ref=trumbowyg">Premirus Corporation</a>
</p>

<p align="center">
    &bull;&bull;&bull;<br>
    <a href="https://www.patreon.com/bePatron?c=1176005&rid=1940456">
        Become a Sponsor
    </a>
</p>

------------------------------------

## Introduction

Trumbowyg is a simple and lightweight WYSIWYG editor, weight only 30kB minified (10kB gzip) for faster page loading.

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

## Documentation

All you need to know about Trumbowyg is here:

- [Get started](https://alex-d.github.io/Trumbowyg/documentation/)
- [25+ Demos](https://alex-d.github.io/Trumbowyg/demos/)
- [45+ Supported languages](https://alex-d.github.io/Trumbowyg/#languages)
- [All Options explained](https://alex-d.github.io/Trumbowyg/documentation/#basic-options)
- [All existing Plugins](https://alex-d.github.io/Trumbowyg/documentation/plugins/)
- [Create your own Plugin](https://alex-d.github.io/Trumbowyg/documentation/plugins/#create-your-own)

## Contribution

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

First, fork and clone the repository

```bash
cd Trumbowyg # go into the project's root directory
npm install # install development dependencies
npm run dev # watch mode
npm run build # to build the project
```

## Author

<table>
  <tr width="100%">
    <td align="center" width="100%">
      <a href="https://github.com/Alex-D">
        <img src="https://avatars2.githubusercontent.com/u/426843?s=150&v=4"><br>
        @Alex-D
      </a> <br>
      <strong>Alexandre Demode</strong><br>
      &bull; &bull; &bull;<br>
      <em>Latest release and announcements</em><br>
      https://x.com/AlexandreDemode
    </td>
  </tr>
</table>

## License

This project is under [MIT license](LICENSE).