Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fex-team/ueditor
rich text 富文本编辑器
https://github.com/fex-team/ueditor
Last synced: about 1 month ago
JSON representation
rich text 富文本编辑器
- Host: GitHub
- URL: https://github.com/fex-team/ueditor
- Owner: fex-team
- License: mit
- Archived: true
- Created: 2012-11-01T10:42:27.000Z (about 12 years ago)
- Default Branch: dev-1.5.0
- Last Pushed: 2023-01-06T03:47:12.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T10:47:19.349Z (7 months ago)
- Language: JavaScript
- Homepage: http://ueditor.baidu.com
- Size: 51.5 MB
- Stars: 6,597
- Watchers: 419
- Forks: 2,408
- Open Issues: 1,105
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wysiwyg - UEditor - UEditor is a WYSIWYG rich web editor developed by Baidu fex-team. It is lightweight, customizable, and user-oriented. (Standalone)
- awesome-web-editor - ueditor - Baidu rich text. (Rich text editor)
- awesome-wysiwyg-editors - UEditor - UEditor 是一个所见即所得的丰富的 WEB 编辑器，由百度 fex-team 开发。它是轻量级的、可定制的和面向用户的。  (独立的)
README
Get Started
=====
> 鉴于目前 ISSUE 较多而维护时间较少，且在进行后续的版本更新，目前暂时关闭 ISSUE，若社区有人跟进，欢迎和我们联系。重复的问题，请参阅常见问题的 [FAQ Wiki](https://github.com/fex-team/ueditor/wiki/FAQ)。
## 重要安全通告：
1. commons-fileupload-1.3.1.jar 存在漏洞可能会导致 ddos，源代码中已经修改，使用老版本的用户，强烈推荐升级 commons-fileupload.jar 至最新版本。（2018-04-09）.
2. UEditor 所提供的所有后端代码都仅为 DEMO 作用，切不可直接使用到生产环境中，目前已知 php 的代码会存在 ssrf 及文件包含漏洞，因此不再提供。
## ueditor富文本编辑器介绍
UEditor是由百度web前端研发部开发所见即所得富文本web编辑器，具有轻量，可定制，注重用户体验等特点，开源基于MIT协议，允许自由使用和修改代码。
## 1 入门部署和体验
### 1.1 下载编辑器
1. `git clone ` 仓库
2. `npm install` 安装依赖（如果没有安装 grunt , 请先在全局安装 grunt）
3. 在终端执行 `grunt default`
### 1.2 创建demo文件
解压下载的包，在解压后的目录创建demo.html文件，填入下面的html代码
```html
ueditor demo
这里写你的初始化内容
var ue = UE.getEditor('container');
```
### 1.3 在浏览器打开demo.html
如果看到了下面这样的编辑器，恭喜你，初次部署成功！
### 1.4 传入自定义的参数
编辑器有很多可自定义的参数项，在实例化的时候可以传入给编辑器：
```javascript
var ue = UE.getEditor('container', {
autoHeight: false
});
```
配置项也可以通过ueditor.config.js文件修改，具体的配置方法请看[前端配置项说明](http://fex.baidu.com/ueditor/#start-config1.4 前端配置项说明.md)
### 1.5 设置和读取编辑器的内容
通getContent和setContent方法可以设置和读取编辑器的内容
```javascript
var ue = UE.getEditor();
//对编辑器的操作最好在编辑器ready之后再做
ue.ready(function(){
//设置编辑器的内容
ue.setContent('hello');
//获取html内容，返回:
hello
var html = ue.getContent();
//获取纯文本内容，返回: hello
var txt = ue.getContentTxt();
});
```
ueditor的更多API请看[API 文档](http://ueditor.baidu.com/doc "ueditor API 文档")
### 1.6 dev-1.5.0 版本二次开发自定义插件注意事项
dev-1.5.0版对于插件的加载逻辑进行了调整，但官网对应的[二次开发功能文档](http://fex.baidu.com/ueditor/#dev-developer)未对相应调整做出开发细节说明，现补充如下：
除进行原有配置外，还需在实例化ueditor编辑器时在 toolbars 参数数组中，加入自定义插件的 uiname，并且注意uiname必须小写，方可正确加载自定义插件。
## 2 详细文档
ueditor 官网：[http://ueditor.baidu.com](http://ueditor.baidu.com "ueditor 官网")
ueditor API 文档：[http://ueditor.baidu.com/doc](http://ueditor.baidu.com/doc "ueditor API 文档")
ueditor github 地址：[http://github.com/fex-team/ueditor](http://github.com/fex-team/ueditor "ueditor github 地址")
ueditor 第三方插件贡献 wiki : [第三方插件贡献规范](http://ueditor.baidu.com/website/thirdproject.html)
ueditor 贡献代码规范（javascript）： [javascript规范](https://github.com/fex-team/styleguide/blob/master/javascript.md)
## 3 第三方贡献
ueditor for nodejs 参考[https://github.com/netpi/ueditor](https://github.com/netpi/ueditor)
## 4 联系我们
email：[[email protected]](mailto://email:[email protected] "发邮件给ueditor开发组")
issue：[github issue](http://github.com/fex-team/ueditor/issues "ueditor 论坛")