# Summernote Super simple WYSIWYG Editor. [![Build Status](https://secure.travis-ci.org/summernote/summernote.svg)](http://travis-ci.org/summernote/summernote) [![npm version](https://badge.fury.io/js/summernote.svg)](http://badge.fury.io/js/summernote) [![Dependency Status](https://gemnasium.com/summernote/summernote.svg)](https://gemnasium.com/summernote/summernote) [![Coverage Status](https://coveralls.io/repos/summernote/summernote/badge.svg?branch=develop&service=github)](https://coveralls.io/github/summernote/summernote?branch=develop) [![Gratipay](https://img.shields.io/gratipay/HackerWins.svg)](https://gratipay.com/~HackerWins/) [![Sauce Test Status](https://saucelabs.com/browser-matrix/summernoteis.svg)](https://saucelabs.com/u/summernoteis) ### Summernote Summernote is a JavaScript library that helps you create WYSIWYG editors online. Home page: ### Why Summernote? Summernote has a few special features: * Paste images from clipboard * Saves images directly in the content of the field using base64 encoding, so you don't need to implement image handling at all * Simple UI * Interactive WYSIWYG editing * Handy integration with server ### Installation and dependencies Summernote uses opensource libraries: [jQuery](http://jquery.com/), [Bootstrap](http://getbootstrap.com), [Font Awesome](https://github.com/FortAwesome/Font-Awesome). For [Meteor](http://github.com/meteor/meteor), just run `meteor add summernote:summernote`. More info in the [Meteor README](meteor/README.md). For other/no frameworks: #### 1. include JS/CSS Include the following code in the `` tag of your HTML: ```html ``` #### 2. target elements Then place a `div` tag somewhere in the `body` tag. This element will be replaced with the summernote editor. ```html
Hello Summernote
``` #### 3. summernote Finally, run this script after the DOM is ready: ```javascript $(document).ready(function() { $('#summernote').summernote(); }); ``` ### API `code` - get the HTML source code underlying the text in the editor: ```javascript var html = $('#summernote').summernote('code'); ``` `Destroy` summernote: ```javascript $('#summernote').summernote('destroy'); ``` #### Warning - code injection The code view allows the user to enter script contents. Make sure to filter/[sanitize the HTML on the server](https://github.com/search?l=JavaScript&q=sanitize+html). Otherwise, an attacker can inject arbitrary JavaScript code into clients. ### Supported platforms Any modern browser: Safari, Chrome, Firefox, Opera, Internet Explorer 9+. ### Upcoming Features * Responsive toolbar * Table: Handles (sizing, selection) and popover * IE8 Support * Clipboard (you can paste images already) * Media object selection ### Developer information #### document structure ``` - body container:
, ,
,