Skip to content

Commit 981209b

Browse files
committed
docs(README): fixes linting errros
1 parent 40570d5 commit 981209b

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
<!-- [fiddle](https://jsfiddle.net/su9zv0w9/1/) -->
2020

21-
# Install
21+
## Install
2222

2323
_You can use Yarn or NPM_
2424

@@ -32,7 +32,7 @@ npm install vue2-editor
3232
yarn add vue2-editor
3333
```
3434

35-
# Usage
35+
## Usage
3636

3737
```javascript
3838
// Basic Use - Covers most scenarios
@@ -42,7 +42,7 @@ import { VueEditor } from "vue2-editor";
4242
import { VueEditor, Quill } from "vue2-editor";
4343
```
4444

45-
# Props
45+
## Props
4646

4747
| Name | Type | Default | Description |
4848
| --------------------- | ------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------- |
@@ -65,9 +65,9 @@ import { VueEditor, Quill } from "vue2-editor";
6565
| selection-change | range, oldRange, source | Emitted on Quill's `selection-change` event |
6666
| text-change | delta, oldDelta, source | Emitted on Quill's `text-change` event |
6767

68-
# Examples
68+
## Examples
6969

70-
## Example - Basic Setup
70+
### Example - Basic Setup
7171

7272
```vue
7373
<template>
@@ -93,7 +93,7 @@ export default {
9393
</script>
9494
```
9595

96-
## Example - Custom Image Handler
96+
### Example - Custom Image Handler
9797

9898
If you choose to use the custom image handler, an event is emitted when a a photo is selected.
9999
You can see below that 3 parameters are passed.
@@ -102,7 +102,7 @@ You can see below that 3 parameters are passed.
102102
2. The Editor instance
103103
3. The cursor position at the time of upload so the image can be inserted at the correct position on success
104104

105-
**NOTE** In addition to this example, I have created a [ example repo](https://github.com/davidroyer/vue2editor-images) demonstrating this new feature with an actual server.
105+
**NOTE** In addition to this example, I have created a [example repo](https://github.com/davidroyer/vue2editor-images) demonstrating this new feature with an actual server.
106106

107107
```vue
108108
<template>
@@ -153,7 +153,7 @@ export default {
153153
</script>
154154
```
155155

156-
## Example - Set Contents After Page Load
156+
### Example - Set Contents After Page Load
157157

158158
```vue
159159
<template>
@@ -186,7 +186,7 @@ export default {
186186
</script>
187187
```
188188

189-
## Example - Using Multiple Editors
189+
### Example - Using Multiple Editors
190190

191191
```vue
192192
<template>
@@ -221,7 +221,7 @@ export default {
221221
</style>
222222
```
223223

224-
## Example - Custom Toolbar
224+
### Example - Custom Toolbar
225225

226226
```vue
227227
<template>
@@ -252,7 +252,7 @@ export default {
252252
</script>
253253
```
254254

255-
## Example - Saving The Content
255+
### Example - Saving The Content
256256

257257
```vue
258258
<template>
@@ -286,7 +286,7 @@ export default {
286286
</script>
287287
```
288288

289-
## Example - Use a Live Preview
289+
### Example - Use a Live Preview
290290

291291
```vue
292292
<template>
@@ -313,11 +313,11 @@ export default {
313313
</script>
314314
```
315315

316-
## How To Use Custom Quill Modules
316+
### How To Use Custom Quill Modules
317317

318318
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

320-
### Version 1 - **_Import and Register Yourself_**
320+
#### Version 1 - **_Import and Register Yourself_**
321321

322322
Vue2Editor now exports Quill to assist in this process.
323323

@@ -362,7 +362,7 @@ Vue2Editor now exports Quill to assist in this process.
362362
</script>
363363
```
364364

365-
### Version 2 - **_You Import | Vue2Editor Registers_**
365+
#### Version 2 - **_You Import | Vue2Editor Registers_**
366366

367367
**_(Recommended way)_**
368368

@@ -407,7 +407,7 @@ export default {
407407

408408
---
409409

410-
# Development
410+
## Development
411411

412412
Vue2Editor now uses [Poi](https://github.com/egoist/poi) for development
413413

@@ -419,6 +419,6 @@ Vue2Editor now uses [Poi](https://github.com/egoist/poi) for development
419419
<!-- # Achnoledgements
420420
Markdown: https://github.com/patleeman/quill-markdown-shortcuts -->
421421

422-
# License
422+
## License
423423

424424
MIT

0 commit comments

Comments
 (0)