Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
surmon committed Nov 28, 2017
1 parent 95eac03 commit 1290dca
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 35 deletions.
33 changes: 6 additions & 27 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,11 @@
### 中文用户请注意:

1. issue 只接受带重现的 bug 报告,请不要用来提问题!不符合要求的 issue 会被直接关闭。
2. 请尽量用英文描述你的 issue,这样能够让尽可能多的人帮到你。
3. 这里不是论坛不是贴吧,是针对问题本身的讨论区,不接受任何问题之外的东西。
4. 在提出问题前,请仔细阅读REMADE.md并在已关闭的问题中寻找与自身相关的问题,它极有可能已经被解决。
5. 问题请严格按照以下模板`BUG REPORT TEMPLATE`编写,禁止在标题中堆砌!

### Got a question?
### 中文用户注意:

- The issue list of this repo is **exclusively** for bug reports and feature requests. For simple questions, please use the following resources:

- Read the docs: https://vuejs.org/guide/
- Look for/ask questions on stack overflow: https://stackoverflow.com/questions/ask?tags=vue.js

### Reporting a bug?

- Try to search for your issue, it may have already been answered or even fixed in the development branch.
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

- It is recommended that you make a JSFiddle/JSBin/Codepen to demonstrate your issue. You could start with [this template](https://jsfiddle.net/39epgLj0/) that already includes the latest version of Vue.

- For potential SSR (Server Side Rendering) issue or bugs that involves build setups, you can create a reproduction repository with steps in the README.

- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

### Have a feature request?

- Remove the template from below and provide thoughtful commentary *and code samples* on what this feature means for your product. What will it allow you to do that you can't do today? How will it make current work-arounds straightforward? What potential bugs and edge cases does it help to avoid? etc. Please keep it product-centric.
1. 尽量用英文描述你的 issue
2. 不要把内容堆彻在标题上,逻辑清晰地写在内容区
3. 贴代码要提前格式化好,有颜色高亮那种,贴文本,不要贴图片
4. 提问题前,必须仔细阅读 REMADE.md + 在已关闭的问题中寻找与自身相关的问题,90% 的可能它已经被解决
5. **如果无法做到提一个合格、优秀的问题,则问题会被 close + block**

### BUG REPORT TEMPLATE

Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
### V3.0.0

#### use
1. require styles
2. add global default options
1. require styles [#111](https://github.com/surmon-china/vue-quill-editor/issues/111)
2. add global default options [#111](https://github.com/surmon-china/vue-quill-editor/issues/110)
3. update `{ editor, text, html }` to `{ quill, text, html }`

#### project
Expand Down
41 changes: 35 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,38 @@
基于 Quill、适用于 Vue 的富文本编辑器,支持服务端渲染和单页应用。


# Example
## Example
[Demo Page](https://surmon-china.github.io/vue-quill-editor/)


# Use
## Use

### Install

#### NPM

``` bash
npm install vue-quill-editor --save
```

#### CDN

``` html
<link rel="stylesheet" href="path/to/quill.core.css"/>
<link rel="stylesheet" href="path/to/quill.snow.css"/>
<link rel="stylesheet" href="path/to/quill.bubble.css"/>
<script type="text/javascript" src="path/to/quill.js"></script>
<script type="text/javascript" src="path/to/vue.min.js"></script>
<script type="text/javascript" src="path/to/dist/vue-quill-editor.js"></script>
<script type="text/javascript">
Vue.use(window.VueQuillEditor, /* { default global options } */)
</script>
```

### Mount

**mount with global**

``` javascript
// import
import Vue from 'vue'
Expand All @@ -50,7 +67,11 @@ require('quill/dist/quill.bubble.css')

// mount with global
Vue.use(VueQuillEditor, /* { default global options } */)
```

**mount with component**

```javascript
// mount with component
import { quillEditor } from 'vue-quill-editor'

Expand All @@ -59,13 +80,21 @@ export default {
quillEditor
}
}
```

**mount with ssr**

```javascript
// mount with ssr
if (process.browser) {
const VueQuillEditor = require('vue-quill-editor/dist/ssr')
Vue.use(VueQuillEditor)
}
```

**register quill module**

```javascript
// register quill modules, you need to introduce and register before the vue program is instantiated
import Quill from 'quill' // or from 'vue-quill-editor'
import { Quill } from 'vue-quill-editor'
Expand Down Expand Up @@ -187,23 +216,23 @@ Quill.register('modules/yourQuillModule', yourQuillModule)
```


# Modules
## Modules
- [quill-image-resize-module](https://github.com/kensnyder/quill-image-resize-module)
- [quill-image-drop-module](https://github.com/kensnyder/quill-image-drop-module)
- [quilljs-table](https://github.com/dost/quilljs-table)
- [more modules...](https://github.com/search?o=desc&q=quill+module&s=stars&type=Repositories&utf8=%E2%9C%93)


# Issues
## Issues
- [Add attributes from toolbar options](https://github.com/quilljs/quill/issues/1084)
- [Option to insert an image from a URLL](https://github.com/quilljs/quill/issues/893)
- [How vue-quill-editor combine with the syntax highlighter module of highlight.js](https://github.com/surmon-china/vue-quill-editor/issues/39)
- [配合 element-ui 实现上传图片/视频到七牛 demo](https://github.com/surmon-china/vue-quill-editor/issues/102)


# Quill documents
## Quill documents
[Api docs](https://quilljs.com/docs/quickstart/)


# Author Blog
## Author Blog
[Surmon](https://surmon.me)

0 comments on commit 1290dca

Please sign in to comment.