Skip to content

Commit abe7437

Browse files
committed
Update document
1 parent c97d337 commit abe7437

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# Vue-Quill-Editor
1313

14-
🍡[Quill](https://github.com/quilljs/quill) editor component for Vue.
14+
[Quill](https://github.com/quilljs/quill) editor component for Vue.
1515

1616
基于 [Quill](https://github.com/quilljs/quill)、适用于 Vue 的富文本编辑器,支持服务端渲染和单页应用。
1717

@@ -46,24 +46,22 @@ npm install vue-quill-editor --save
4646

4747
### Mount
4848

49-
#### Mount with global
49+
**Mount with global**
5050

5151
``` javascript
5252
import Vue from 'vue'
5353
import VueQuillEditor from 'vue-quill-editor'
5454

55-
// require styles
56-
import 'quill/dist/quill.core.css'
57-
import 'quill/dist/quill.snow.css'
58-
import 'quill/dist/quill.bubble.css'
55+
import 'quill/dist/quill.core.css' // import styles
56+
import 'quill/dist/quill.snow.css' // for snow theme
57+
import 'quill/dist/quill.bubble.css' // for bubble theme
5958

6059
Vue.use(VueQuillEditor, /* { default global options } */)
6160
```
6261

63-
#### Mount with local component
62+
**Mount with local component**
6463

6564
```javascript
66-
// require styles
6765
import 'quill/dist/quill.core.css'
6866
import 'quill/dist/quill.snow.css'
6967
import 'quill/dist/quill.bubble.css'
@@ -77,7 +75,7 @@ export default {
7775
}
7876
```
7977

80-
#### Mount with SSR
78+
**Mount with SSR**
8179

8280
View [Nuxt.js example code](https://github.com/surmon-china/surmon-china.github.io/tree/source/projects/vue-quill-editor/nuxt).
8381

@@ -116,7 +114,7 @@ Quill.register('modules/yourQuillModule', yourQuillModule)
116114
<script>
117115
// You can also register Quill modules in the component
118116
import Quill from 'quill'
119-
import { someModule } from '../yourModulePath/someQuillModule.js'
117+
import someModule from '../yourModulePath/someQuillModule.js'
120118
Quill.register('modules/someModule', someModule)
121119
122120
export default {
@@ -155,17 +153,10 @@ Quill.register('modules/yourQuillModule', yourQuillModule)
155153
</script>
156154
```
157155

158-
### Projects Using vue-quill-editor
156+
### Projects using vue-quill-editor
159157
- [Tamiat CMS](https://github.com/tamiat/tamiat/)
160158
- ...
161159

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

170161
### Issues
171162
- [Add attributes from toolbar options](https://github.com/quilljs/quill/issues/1084)
@@ -175,6 +166,14 @@ Quill.register('modules/yourQuillModule', yourQuillModule)
175166
- [How to fix “Can’t find variable: Quill”, “Quill is undefined”, “window.Quill is undefined” errors when trying to use Quill modules that use Webpack in Nuxt/SSR](https://github.com/surmon-china/vue-quill-editor/issues/171#issuecomment-370253411)
176167

177168

169+
### Quill Modules
170+
- [quill-image-extend-module](https://github.com/NextBoy/quill-image-extend-module)
171+
- [quill-image-resize-module](https://github.com/kensnyder/quill-image-resize-module)
172+
- [quill-image-drop-module](https://github.com/kensnyder/quill-image-drop-module)
173+
- [quilljs-table](https://github.com/dost/quilljs-table)
174+
- [more modules...](https://github.com/search?o=desc&q=quill+module&s=stars&type=Repositories&utf8=%E2%9C%93)
175+
176+
178177
### Quill
179178
[Quill API document](https://quilljs.com/docs/quickstart/)
180179

0 commit comments

Comments
 (0)