Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/summernote/summernote
Super simple WYSIWYG editor
https://github.com/summernote/summernote
javascript summernote wysiwyg wysiwyg-editor
Last synced: 6 days ago
JSON representation
Super simple WYSIWYG editor
- Host: GitHub
- URL: https://github.com/summernote/summernote
- Owner: summernote
- License: mit
- Created: 2013-04-27T04:59:48.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-05T14:08:30.000Z (6 months ago)
- Last Synced: 2024-05-16T14:25:11.848Z (6 months ago)
- Topics: javascript, summernote, wysiwyg, wysiwyg-editor
- Language: JavaScript
- Homepage: https://summernote.org
- Size: 19 MB
- Stars: 11,387
- Watchers: 295
- Forks: 2,239
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - summernote/summernote - Super simple WYSIWYG editor (JavaScript)
- awesome-wysiwyg - Summernote - Super simple WYSIWYG editor. (JQuery Based)
- awesome-web-editor - summernote - Super simple WYSIWYG editor, Summernote is built on jQuery. (Rich text editor)
- awesome - summernote/summernote - Super simple WYSIWYG editor (JavaScript)
- awesome-github-repos - summernote/summernote - Super simple WYSIWYG editor (JavaScript)
- made-in-korea - summernote
- awesome-wysiwyg-editors - Summernote - 超级简单的 WYSIWYG 编辑器。  (基于 JQuery)
- starred-awesome - summernote - Super simple WYSIWYG editor (JavaScript)
- awesome-starred - summernote/summernote - Super simple WYSIWYG editor (javascript)
README
# Summernote
Super simple WYSIWYG Editor.
[](http://travis-ci.org/summernote/summernote)
[](http://badge.fury.io/js/summernote)
[](https://coveralls.io/github/summernote/summernote?branch=develop)
### 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
* Supports Bootstrap 3, 4 and 5 integrations
* Lots of [plugins and connectors](https://github.com/summernote/awesome-summernote) provided together
### Installation and dependencies
Summernote is built on [jQuery](http://jquery.com/).
#### 1. Include JS/CSS
Include the following code in the `` tag of your HTML:
```html
```
#### 2. Target a element
Then place a `div` tag somewhere in the `body` tag. This element will be replaced with the summernote editor.
```html
Hello Summernote
```
#### 3. Summernote it!
Finally, run this script after the DOM is ready:
```javascript
$(document).ready(function() {
$('#summernote').summernote();
});
```
For more examples, please visit to [homepage](http://summernote.org/examples).
### API
`code` - 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
https://github.com/summernote/summernote/blob/develop/.github/CONTRIBUTING.md
### Contacts
* Facebook user group: https://www.facebook.com/groups/summernote
* Summernote Slack: [Join the Summernote Slack community](https://communityinviter.com/apps/summernote/summernote)
## Testing powered by
[BrowserStack Open-Source Program](https://www.browserstack.com/open-source)
### License
Summernote may be freely distributed under the MIT license.