You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Quill** is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and actively maintained by [Slab](https://slab.com/).
5
+
::: warning
6
+
🚀 **VueQuill** is in **@alpha** version! Currently the focus is on making VueQuill stable and feature complete first. It is not recommended to use this for anything serious yet. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions.
7
+
:::
6
8
7
-
You can learn more about the rationale behind the project in the [Why Quill](https://quilljs.com/guides/why-quill/) guides.
9
+
</div>
8
10
9
11
## What is VueQuill
10
12
11
13
**VueQuill** is a **Vue Component** for building rich text editors, this package is a thin wrapper around Quill to make it easier to use in a Vue 3 application.
12
14
15
+
## What is Quill
16
+
17
+
**Quill** is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and actively maintained by [Slab](https://slab.com/).
18
+
19
+
You can learn more about the rationale behind the project in the [Why Quill](https://quilljs.com/guides/why-quill/) guides.
20
+
13
21
## Browser Support
14
22
15
23
Cross-platform support is important to many Javascript libraries, but the criteria for what this means often differ. For Quill, the bar is not just that it runs or works, it has to run or work the same way. Not only is functionality a cross-platform consideration, but the user and developer experience are as well. If some content produces a particular markup in Chrome on OSX, it will produce the same markup on IE. If hitting enter preserves bold format state in Firefox on Windows, it will be preserved on mobile Safari.
@@ -19,3 +27,23 @@ Quill supports all modern browsers on desktops, tablets, and phones. Experience
19
27
## Community
20
28
21
29
If you have questions or need help, reach out to the community at [GitHub Discussions](https://github.com/vueup/vue-quill/discussions).
30
+
31
+
<!-- TextReplacer used to replace text after component mounted -->
Copy file name to clipboardExpand all lines: docs/content/guide/installation.md
+41-25Lines changed: 41 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,48 +8,64 @@ This guide assumes intermediate-level knowledge of Vue 3. If you are totally new
8
8
9
9
VueQuill ships as a UMD module that is accessible in the browser. When loaded in the browser, you can access the component through the `VueQuill.QuillEditor` global variable. You'll need to load Vue.js, VueQuill JS & VueQuill CSS theme.
For production, we recommend linking to a specific version number and build to avoid unexpected breakage from newer versions.
29
-
:::
26
+
::: warning
27
+
For production, we recommend linking to a specific version number and build to avoid unexpected breakage from newer versions.
28
+
:::
30
29
31
30
## NPM / Yarn
32
31
33
32
Use the package manager [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/) to install VueQuill.
34
33
35
34
```bash
36
-
npm install @vueup/vue-quill --save
35
+
npm install @vueup/vue-quill@latest --save
37
36
# OR
38
-
yarn add @vueup/vue-quill
37
+
yarn add @vueup/vue-quill@latest
39
38
```
40
39
40
+
</div>
41
+
41
42
npm or yarn is the recommended installation method when you are using [Single File Component](usage.md#in-single-file-component), and then you can register the [Component](usage.md#in-single-file-component) in your app.
42
43
43
-
<!--GithubVersionSetter used to replace target with the latest github-release tag name-->
44
+
<!--TextReplacer used to replace text after component mounted-->
0 commit comments