Skip to content

Commit 81afec9

Browse files
更新文档
1 parent e1c9b88 commit 81afec9

File tree

9 files changed

+76
-8
lines changed

9 files changed

+76
-8
lines changed

docs/dev/README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,22 @@
11
面向开发者的文档
22

3-
修改代码之后的步骤,例如
43

4+
框架介绍
5+
6+
- 下载和运行
7+
- 目录结构介绍
8+
- `example`目录
9+
- `src`目录(`js`目录,`less`目录)
10+
- `package.json`
11+
- `gulpfile.js`
12+
13+
如何提交 PR
14+
15+
16+
17+
上线
18+
19+
- 修改`package.json`版本
520
- 提交到github,并创建tag
621
- 提交到 npm
722
- 同步到官网
@@ -10,4 +25,3 @@
1025
- 文档同步到 kancloud
1126
- ……
1227

13-

docs/usage/05-other/01-全屏-预览-查看源码.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## 全屏
44

5-
## 预览
5+
虽然 wangEditor 没有内置全屏功能,但是你可以通过简单的代码来搞定,作者已经做了一个demo来示范。通过运行 demo(文档一开始就介绍了)即可看到该示例页面,直接查看页面源代码即可。
66

7-
## 查看源码
7+
## 预览 & 查看源码
8+
9+
如果需要预览和查看源码的功能,也需要跟全屏功能一样,自己定义按钮。点击按钮时通过`editor.txt.html()`获取编辑器内容,然后自定义实现预览和查看源码功能。
810

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
# 关于上传附件
22

3+
**有用户问到编辑器能否有上传附件的功能?我的建议是不要把附件做到内容中。**
4+
5+
原因很简单,如果将附件上传之后再插入到富文本内容中,其实就是一个链接的形式。如下图:
6+
7+
![](http://box.kancloud.cn/2016-02-19_56c718ec6f9bf.png)
8+
9+
而用户在用编辑器编辑文本时,操作是非常随意多样的,他把这个链接删了,你服务器要想实时删除上传的附件文件,是难监控到的。
10+
11+
还有,用户如果要上传很多个附件,也是很难管理的,还是因为富文本的内容变化多样,用户可以随便在什么地方插入附件,而且形式和链接一样。
12+
13+
-------
14+
15+
反过来,我们想一下平时用附件和编辑器最多的产品是什么——是邮箱。邮箱如何处理附件的,大家应该很清楚。它把文本内容和附件分开,这样附件就可以很轻松、明了的进行管理,绝对不会和编辑内容的链接产生混淆。
16+
17+
![](http://box.kancloud.cn/2016-02-19_56c718ec83f7e.png)
18+
19+
你能看到的所有的邮箱产品,几乎都是这样设计的。
20+
21+
-------
22+
23+
因此,在你提问编辑器能否上传附件这个问题的时候,可以想一下能否参照邮箱的实现来设计?
24+

docs/usage/05-other/03-markdown.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
11
# 关于 markdown
2+
3+
**好多使用者问到,wangEditor编辑器能否集成markdown?——答案是:富文本编辑器无法和markdown集成到一起。**
4+
5+
-----
6+
7+
8+
你可以参考 [简书](http://www.jianshu.com/) 的实现方式,简书中编辑器也无法实现富文本和`markdown`的自由切换。要么使用富文本编写文章,要么使用`markdown`编写文章,不能功能。
9+
10+
本质上,富文本编辑器和`markdown`编辑器是两回事儿。
11+
12+

docs/usage/05-other/04-xss.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
# 预防 XSS 攻击
1+
# 预防 XSS 攻击
2+
3+
> 术业有专攻
4+
5+
要想在前端预防 xss 攻击,还得依赖于其他工具,例如[xss.js](http://jsxss.com/zh/index.html)(如果打不开页面,就从百度搜一下)
6+
7+
代码示例如下
8+
9+
```html
10+
<script src='/xss.js'></script>
11+
<script src='/wangEditor.min.js'></script>
12+
<script>
13+
var E = window.wangEditor
14+
var editor = new E('#div1')
15+
16+
document.getElementById('btn1').addEventListener('click', function () {
17+
var html = editor.txt.html()
18+
var filterHtml = filterXSS(html) // 此处进行 xss 攻击过滤
19+
alert(filterHtml)
20+
}, false)
21+
</script>
22+
```
23+
File renamed without changes.

docs/usage/05-other/05-插入视频.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.

docs/usage/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
同步[../../README.md](../../README.md)的内容
2-
3-
- 快速解决问题的方式??

0 commit comments

Comments
 (0)