Skip to content

Commit b78abb8

Browse files
davidroyerdavidroyer
committed
docs: fixes and updates
1 parent 5e611ee commit b78abb8

File tree

9 files changed

+42
-106
lines changed

9 files changed

+42
-106
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ export default {
315315

316316
## How To Use Custom Quill Modules
317317

318-
There are 2 ways of using custom modules with Vue2Editor. This is partly because there have been cases in which errors are thrown when importing and attempting to declare custom modules, and partly because I believe it actually separates the concerns nicely.
318+
There are two ways of using custom modules with Vue2Editor. This is partly because there have been cases in which errors are thrown when importing and attempting to declare custom modules, and partly because I believe it actually separates the concerns nicely.
319319

320320
### Version 1 - **_Import and Register Yourself_**
321321

‎docs/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ module.exports = {
6262
}
6363
],
6464
sidebar: [
65-
"/installation.md",
65+
// "/installation.md",
6666
"/guide.md",
6767
"/examples/",
6868
"/api.md",

‎docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
home: true
33
heroImage: /hero-home.png
44
actionText: Get Started →
5-
actionLink: /installation.md
5+
actionLink: /guide.md
66
features:
77
- title: Easy To Use
88
details: Simple setup so you can get started quickly

‎docs/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export default {
135135

136136
## How To Use Custom Quill Modules
137137

138-
There are 2 ways of using custom modules with Vue2Editor. This is partly because there have been cases in which errors are thrown when importing and attempting to declare custom modules, and partly because I believe it actually separates the concerns nicely.
138+
There are two ways of using custom modules with Vue2Editor. This is partly because there have been cases in which errors are thrown when importing and attempting to declare custom modules, and partly because I believe it actually separates the concerns nicely.
139139

140140
::: tip TIP
141141
_If you have errors when using custom modules,

‎docs/faq/README.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎docs/guide.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
11
# Guide
22

3+
## Installation
4+
5+
### Using CDN
6+
7+
The plugin will automatically install itself as a Vue plugin.
8+
9+
<!-- https://unpkg.com/vue2-editor/dist/vue2-editor -->
10+
11+
<!-- [unpkg.com](https://unpkg.com) provides NPM-based CDN links. The above link will always point to the latest release on NPM. You can also use a specific version/tag via URLs like https://unpkg.com/vue2-editor@{{ $version }}/dist/vue2-editor.js
12+
13+
Include vue2-editor after Vue and it will install itself automatically: -->
14+
15+
```html
16+
<script src="https://unpkg.com/vue/dist/vue.js"></script>
17+
<script src="https://unpkg.com/vue2-editor/dist/vue2-editor.umd.min.js"></script>
18+
```
19+
20+
### NPM
21+
22+
```sh
23+
$ npm install vue2-editor
24+
```
25+
26+
### Yarn
27+
28+
```sh
29+
$ yarn add vue2-editor
30+
```
31+
32+
<br>
33+
334
## Usage
435

5-
There are 2 ways to Vue2Editor. You can either set it up globally as a Vue plugin or import the `VueEditor` component to locally register and use it. Examples of both way are below.
36+
There are two ways setup and use Vue2Editor. You can either set it up globally as a Vue plugin or import the `VueEditor` component to locally register and use it. Examples of both way are below.
637

738
### Globally
839

@@ -25,11 +56,9 @@ import { VueEditor } from "vue2-editor";
2556
import { VueEditor, Quill } from "vue2-editor";
2657
```
2758

28-
## Advanced Control
59+
## Modular Version
2960

3061
As of version 2.9, you can use the modarl version which includeds only the JavaScript.
3162
This allows for more control and customization. Also, this allows for other Quill themes to be used such as Bubble.
3263

33-
## Modular Version
34-
3564
<<< @/docs/.vuepress/snippets/modular.vue

‎docs/guide/README.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/installation.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎docs/notes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ All of Quill's functionality referenced in their docs is available by providing
66

77
**For example:**
88

9-
``` html
9+
```vue
1010
<template>
1111
<div>
1212
<button @click="getEditorText">Get Text</button>
@@ -17,14 +17,14 @@ All of Quill's functionality referenced in their docs is available by providing
1717
<script>
1818
export default {
1919
data: () => ({
20-
content: ''
20+
content: ""
2121
}),
2222
2323
methods: {
2424
getEditorText() {
25-
console.log(this.$refs.vEditor.quill.getText())
25+
console.log(this.$refs.vEditor.quill.getText());
2626
}
2727
}
28-
}
28+
};
2929
</script>
30-
```
30+
```

0 commit comments

Comments
 (0)