Super simple WYSIWYG Editor.
Summernote is a JavaScript library that helps you create WYSIWYG editors online.
Home page: http://summernote.org
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
Summernote uses opensource libraries: jQuery, Bootstrap.
For Meteor, just run meteor add summernote:summernote
. More info in the Meteor README.
Also there's an adaptation for React: react-summernote
For other/no frameworks:
Include the following code in the <head>
tag of your HTML:
<!-- include libraries(jQuery, bootstrap) -->
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/css/bootstrap.min.css" />
<script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
<!-- include summernote css/js-->
<link href="summernote.css" rel="stylesheet">
<script src="summernote.js"></script>
Then place a div
tag somewhere in the body
tag. This element will be replaced with the summernote editor.
<div id="summernote">Hello Summernote</div>
Finally, run this script after the DOM is ready:
$(document).ready(function() {
$('#summernote').summernote();
});
For more examples, please visit to homepage.
code
- get the HTML source code underlying the text in the editor:
var html = $('#summernote').summernote('code');
For more detail about API, please refer to document.
The code view allows the user to enter script contents. Make sure to filter/sanitize the HTML on the server. Otherwise, an attacker can inject arbitrary JavaScript code into clients.
- body container: <div class="note-editable">, <td>, <blockquote>, <ul>
- block node: <div>, <p>, <li>, <h1>, <table>
- void block node: <hr>
- inline node: <span>, <b>, <font>, <a>, ...
- void inline node: <img>
- text node: #text
- A body container has block node, but
<ul>
has only<li>
nodes. - A body container also has inline nodes sometimes. This inline nodes will be wraped with
<p>
when enter key pressed. - A block node only has inline nodes.
- A inline nodes has another inline nodes
#text
and void inline node doesn't have children.
npm install
# build full version of summernote: dist/summernote.js
npm run build
# generate minified copy: dist/summernote.min.js, dist/summernote.css
npm run dist
At this point, you should now have a build/
directory populated with everything you need to use summernote.
run tests with Karma and PhantomJS
npm test
If you want run tests on other browser,
change the values for broswers
properties in Gruntfile.js
.
karma: {
all: {
browsers: ['PhantomJS'],
reporters: ['progress']
}
}
You can use Chrome
, ChromeCanary
, Firefox
, Opera
, Safari
, PhantomJS
and IE
beside PhantomJS
.
Once you run npm test
, it will watch all javascript file. Therefore karma run tests every time you chage code.
run local server with connect and watch.
npm run server
# Open a browser on http://localhost:3000.
# If you change source code, automatically reload your page.
- JSHint: http://www.jshint.com/about/
- JSHint rule: https://github.com/summernote/summernote/blob/master/.jshintrc
- Pull requests are welcome
- Please don't include dist/* files on your commits.
- Email: [email protected]
- Twitter: http://twitter.com/hackerwins
- Chat with us:
summernote may be freely distributed under the MIT license.