Skip to content

Commit 09ee28a

Browse files
Upgrade docs
1 parent 428a792 commit 09ee28a

File tree

13 files changed

+12
-115
lines changed

13 files changed

+12
-115
lines changed

README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# Simple CodeEditor for Vue.js
1+
# Simple CodeEditor for Vue.js 3
22

3-
Vue.js 3 support
3+
Support for **Vue.js 3**
44

55
website: [simple-code-editor.vicuxd.com](https://simple-code-editor.vicuxd.com)
66

77
It's easy to use, both support read-only and edit mode with 200+ themes, you can directly use it in the browser or import it via the NPM package.
88

99
## Usage
1010

11-
There are 3 common ways that you can use the `simple-code-editor` package:
11+
There are 2 common ways that you can use the `simple-code-editor` package:
1212

1313
1. Vue in the browser
1414
2. Vue via NPM
15-
3. NuxtJS via NPM
1615

1716
### 1. Vue in the Browser
1817

@@ -69,37 +68,6 @@ export default {
6968
<CodeEditor></CodeEditor>
7069
```
7170

72-
### 3. Usage with NuxtJS via NPM
73-
74-
Step 1. Install the `simple-code-editor` package from NPM:
75-
76-
```shell
77-
npm install simple-code-editor
78-
```
79-
80-
Step 2. In your `nuxt.config.js` file, add the `simple-code-editor` module:
81-
82-
```js
83-
modules: ["simple-code-editor/nuxt"];
84-
```
85-
86-
Step 3. After adding the global module, you will be able to use the `code-editor` or `CodeEditor` component throughout your Nuxt project:
87-
88-
```vue
89-
<template>
90-
<client-only>
91-
<code-editor value="console.log(13)"></code-editor>
92-
<!-- or -->
93-
<CodeEditor value="console.log(13)"></CodeEditor>
94-
</client-only>
95-
<template></template>
96-
</template>
97-
```
98-
99-
**NOTE:** While using the code editor with Nuxt, it is recommended to wrap each `CodeEditor` component with the `client-only` tags like the example above. This will prevent a client side hydration error.
100-
101-
102-
10371
## Props
10472

10573
### read-only ` Boolean`
@@ -378,4 +346,4 @@ Description: pass the textarea element as an argument
378346
focus(node) {
379347
node.focus();
380348
}
381-
```
349+
```

npm-package/README.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# Simple CodeEditor for Vue.js
1+
# Simple CodeEditor for Vue.js 3
22

3-
Vue.js 3 support
3+
Support for **Vue.js 3**
44

55
website: [simple-code-editor.vicuxd.com](https://simple-code-editor.vicuxd.com)
66

77
It's easy to use, both support read-only and edit mode with 200+ themes, you can directly use it in the browser or import it via the NPM package.
88

99
## Usage
1010

11-
There are 3 common ways that you can use the `simple-code-editor` package:
11+
There are 2 common ways that you can use the `simple-code-editor` package:
1212

1313
1. Vue in the browser
1414
2. Vue via NPM
15-
3. NuxtJS via NPM
1615

1716
### 1. Vue in the Browser
1817

@@ -69,37 +68,6 @@ export default {
6968
<CodeEditor></CodeEditor>
7069
```
7170

72-
### 3. Usage with NuxtJS via NPM
73-
74-
Step 1. Install the `simple-code-editor` package from NPM:
75-
76-
```shell
77-
npm install simple-code-editor
78-
```
79-
80-
Step 2. In your `nuxt.config.js` file, add the `simple-code-editor` module:
81-
82-
```js
83-
modules: ["simple-code-editor/nuxt"];
84-
```
85-
86-
Step 3. After adding the global module, you will be able to use the `code-editor` or `CodeEditor` component throughout your Nuxt project:
87-
88-
```vue
89-
<template>
90-
<client-only>
91-
<code-editor value="console.log(13)"></code-editor>
92-
<!-- or -->
93-
<CodeEditor value="console.log(13)"></CodeEditor>
94-
</client-only>
95-
<template></template>
96-
</template>
97-
```
98-
99-
**NOTE:** While using the code editor with Nuxt, it is recommended to wrap each `CodeEditor` component with the `client-only` tags like the example above. This will prevent a client side hydration error.
100-
101-
102-
10371
## Props
10472

10573
### read-only ` Boolean`
@@ -378,4 +346,4 @@ Description: pass the textarea element as an argument
378346
focus(node) {
379347
node.focus();
380348
}
381-
```
349+
```

npm-package/nuxt/module.js

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

npm-package/nuxt/package.json

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

npm-package/nuxt/plugin.js

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

npm-package/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "simple-code-editor",
3-
"version": "2.0.8",
3+
"version": "2.0.9",
44
"description": "Simple code editor for Vue.js",
55
"main": "CodeEditor.vue",
66
"scripts": {

website/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/dist/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<link rel="icon" type="image/svg+xml" href="./favicon.ico" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<title>simple-code-editor-website</title>
8-
<script type="module" crossorigin src="/assets/index-13dc0cd6.js"></script>
8+
<script type="module" crossorigin src="/assets/index-97f618de.js"></script>
99
<link rel="stylesheet" href="/assets/index-c5225c12.css">
1010
</head>
1111
<body>

website/src/SimpleCodeEditor/nuxt/module.js

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

0 commit comments

Comments
 (0)