summernote
Version:
Super simple WYSIWYG editor
101 lines (64 loc) • 4.18 kB
Markdown
# Summernote
[](http://travis-ci.org/summernote/summernote)
[](http://badge.fury.io/js/summernote)
[](https://coveralls.io/github/summernote/summernote?branch=develop)
Summernote is a JavaScript library that helps you create WYSIWYG editors with a simple and easy-to-use interface. Summernote is licensed under MIT and maintained by the community.
Homepage: <https://summernote.org>
## Why Summernote?
Summernote has a few special features:
- **Simple and User-friendly**: Providing a simple and intuitive interface that allows users
- **Easy to install**: Just include the JS/CSS files on your HTML and create a div tag to get started.
- **Compatible with Bootstrap**: Bootstrap 3, 4, and 5.
- **Rich ecosystem**: A wide array of [plugins and connectors](https://github.com/summernote/awesome-summernote) are available, enhancing functionality and integration options.
- **Easy image handling**: Images are automatically embedded in the content using base64 encoding, eliminating the need for separate image management
## How to Use
Summernote is built on [jQuery](http://jquery.com/).
### How to install
#### 1. Include JS/CSS
Include the following code in the `<head>` tag of your HTML:
```html
<!-- include libraries(jQuery, bootstrap) -->
<script type="text/javascript" src="//code.jquery.com/jquery-3.6.0.min.js"></script>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" />
<script type="text/javascript" src="cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js"></script>
<!-- include summernote css/js-->
<link href="summernote-bs5.css" rel="stylesheet">
<script src="summernote-bs5.js"></script>
```
#### 2. Place a `div` tag
Then place a `div` tag somewhere in the `body` tag. This element will be replaced with the summernote editor.
```html
<div id="summernote">Hello Summernote</div>
```
#### 3. Initialize Summernote
Finally, initialize Summernote with the following JavaScript:
```javascript
$(document).ready(function() {
$('#summernote').summernote();
});
```
For more examples, please visit to [homepage](http://summernote.org/examples).
### API
Summernote provides a set of API. For example, you can use the following code to get the HTML source code underlying the text in the editor:
```javascript
var html = $('#summernote').summernote('code');
```
For more detail about API, please refer to [document](http://summernote.org/getting-started/#basic-api).
> 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.
## For contributing
See the [CONTRIBUTING.md]( https://github.com/summernote/summernote/blob/main/.github/CONTRIBUTING.md) for details on how to contribute to Summernote.
## Contributors ✨
Thanks go to these incredible people:
<a href="https://github.com/summernote/summernote/graphs/contributors">
<img src="https://contrib.rocks/image?repo=summernote/summernote" alt="contributors"/>
</a>
## Sponsors
Is your company using Summernote? Ask your boss to support us. It will help us dedicate more time to maintain this project and to make it even better for all our users. Also, your company logo will show up on here and on our website: -) [[Become a sponsor](https://opencollective.com/summernote#sponsor)]
<a href="https://opencollective.com/summernote#sponsor" target="_
blank"><img src="https://opencollective.com/summernote/sponsor.svg?width=890"></a>
### Backers
Please be our [Backers](https://opencollective.com/summernote#backers).
<a href="https://opencollective.com/summernote#backers" target="_blank"><img src="https://opencollective.com/summernote/backers.svg?width=890"></a>
## Contacts
* Discord: [Join the Summernote Discord community](https://discord.gg/7A64GBKwyu)