@activix/summernote 中文文档教程

Question

Summernote

超级简单的所见即所得编辑器。

Summernote

Summernote 是一个 JavaScript 库，可帮助您在线创建所见即所得的编辑器。

主页：https://summernote.org

Why Summernote?

Summernote 有一些特殊功能：

• 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 and 4 integrities
• Lots of plugins and connectors provided together

Installation and dependencies

Summernote 建立在 jQuery.

1. Include JS/CSS

在 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>

2. Target a element

然后将 div 标签放在 body 标签的某处。 此元素将替换为 summernote 编辑器。

<div id="summernote">Hello Summernote</div>

3. Summernote it!

最后，在 DOM 准备好后运行此脚本：

$(document).ready(function() {
  $('#summernote').summernote();
});

有关更多示例，请访问主页。

API

code - 获取编辑器中文本的 HTML 源代码：

var html = $('#summernote').summernote('code');

有关 API 的更多详细信息，请参阅 文件。

Warning - code injection

代码视图允许用户输入脚本内容。 确保过滤/清理服务器上的 HTML。 否则，攻击者可以将任意 JavaScript 代码注入客户端。

For contributing

https://github.com/summernote/summernote/blob/develop/CONTRIBUTING.md

Contacts

• Facebook user group: https://www.facebook.com/groups/summernote
• Summernote Slack: Join the Summernote Slack community

License

Summernote 可以在 MIT 许可下自由分发。