@licium/editor-plugin-code-syntax-highlight 3.1.0 → 3.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -22
- package/package.json +3 -3
- package/LICENSE +0 -21
package/README.md
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
|
+
> This is a fork of the [Toast UI Editor](https://github.com/natorus87/tui.editor) maintained by `@licium`.
|
|
2
|
+
> Original repository: https://github.com/natorus87/tui.editor
|
|
3
|
+
|
|
1
4
|
# TOAST UI Editor : Code Syntax Highlight Plugin
|
|
2
5
|
|
|
3
|
-
> This is a plugin of [TOAST UI Editor](https://github.com/
|
|
6
|
+
> This is a plugin of [TOAST UI Editor](https://github.com/natorus87/tui.editor/tree/master/apps/editor) to highlight code syntax.
|
|
4
7
|
|
|
5
|
-
[](https://www.npmjs.com/package/@licium/editor-plugin-code-syntax-highlight)
|
|
6
9
|
|
|
7
10
|

|
|
8
11
|
|
|
@@ -44,14 +47,14 @@
|
|
|
44
47
|
|
|
45
48
|
## 📦 Usage npm
|
|
46
49
|
|
|
47
|
-
To use the plugin, [`@
|
|
50
|
+
To use the plugin, [`@licium/editor`](https://github.com/natorus87/tui.editor/tree/master/apps/editor) must be installed.
|
|
48
51
|
|
|
49
|
-
> Ref. [Getting Started](https://github.com/
|
|
52
|
+
> Ref. [Getting Started](https://github.com/natorus87/tui.editor/blob/master/docs/en/getting-started.md)
|
|
50
53
|
|
|
51
54
|
### Install
|
|
52
55
|
|
|
53
56
|
```sh
|
|
54
|
-
$ npm install @
|
|
57
|
+
$ npm install @licium/editor-plugin-code-syntax-highlight
|
|
55
58
|
```
|
|
56
59
|
|
|
57
60
|
### Import Plugin
|
|
@@ -63,18 +66,18 @@ The `code-syntax-highlight` plugin has [`prismjs`](https://prismjs.com/) as a de
|
|
|
63
66
|
|
|
64
67
|
```js
|
|
65
68
|
import 'prismjs/themes/prism.css';
|
|
66
|
-
import '@
|
|
69
|
+
import '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css';
|
|
67
70
|
|
|
68
|
-
import codeSyntaxHighlight from '@
|
|
71
|
+
import codeSyntaxHighlight from '@licium/editor-plugin-code-syntax-highlight';
|
|
69
72
|
```
|
|
70
73
|
|
|
71
74
|
#### CommonJS
|
|
72
75
|
|
|
73
76
|
```js
|
|
74
77
|
require('prismjs/themes/prism.css');
|
|
75
|
-
require('@
|
|
78
|
+
require('@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css');
|
|
76
79
|
|
|
77
|
-
const codeSyntaxHighlight = require('@
|
|
80
|
+
const codeSyntaxHighlight = require('@licium/editor-plugin-code-syntax-highlight');
|
|
78
81
|
```
|
|
79
82
|
|
|
80
83
|
### Create Instance
|
|
@@ -90,10 +93,10 @@ The main bundle file of `prismjs` contains just several language pack it support
|
|
|
90
93
|
```js
|
|
91
94
|
// ...
|
|
92
95
|
import 'prismjs/themes/prism.css';
|
|
93
|
-
import '@
|
|
96
|
+
import '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css';
|
|
94
97
|
|
|
95
|
-
import Editor from '@
|
|
96
|
-
import codeSyntaxHighlight from '@
|
|
98
|
+
import Editor from '@licium/editor';
|
|
99
|
+
import codeSyntaxHighlight from '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight-all.js';
|
|
97
100
|
|
|
98
101
|
|
|
99
102
|
const editor = new Editor({
|
|
@@ -109,7 +112,7 @@ You need to import the language files you want to use in the code block and regi
|
|
|
109
112
|
```js
|
|
110
113
|
// ...
|
|
111
114
|
import 'prismjs/themes/prism.css';
|
|
112
|
-
import '@
|
|
115
|
+
import '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css';
|
|
113
116
|
|
|
114
117
|
// Step 1. Import prismjs
|
|
115
118
|
import Prism from 'prismjs';
|
|
@@ -117,8 +120,8 @@ import Prism from 'prismjs';
|
|
|
117
120
|
// Step 2. Import language files of prismjs that you need
|
|
118
121
|
import 'prismjs/components/prism-clojure.js';
|
|
119
122
|
|
|
120
|
-
import Editor from '@
|
|
121
|
-
import codeSyntaxHighlight from '@
|
|
123
|
+
import Editor from '@licium/editor';
|
|
124
|
+
import codeSyntaxHighlight from '@licium/editor-plugin-code-syntax-highlight';
|
|
122
125
|
|
|
123
126
|
const editor = new Editor({
|
|
124
127
|
// ...
|
|
@@ -133,13 +136,13 @@ As with creating an editor instance, you need to import `prismjs` and pass it to
|
|
|
133
136
|
```js
|
|
134
137
|
// ...
|
|
135
138
|
import 'prismjs/themes/prism.css';
|
|
136
|
-
import '@
|
|
139
|
+
import '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css';
|
|
137
140
|
|
|
138
141
|
// Import prismjs
|
|
139
142
|
import Prism from 'prismjs';
|
|
140
143
|
|
|
141
|
-
import Viewer from '@
|
|
142
|
-
import codeSyntaxHighlight from '@
|
|
144
|
+
import Viewer from '@licium/editor/dist/toastui-editor-viewer';
|
|
145
|
+
import codeSyntaxHighlight from '@licium/editor-plugin-code-syntax-highlight';
|
|
143
146
|
|
|
144
147
|
|
|
145
148
|
const viewer = new Viewer({
|
|
@@ -153,13 +156,13 @@ or
|
|
|
153
156
|
```js
|
|
154
157
|
// ...
|
|
155
158
|
import 'prismjs/themes/prism.css';
|
|
156
|
-
import '@
|
|
159
|
+
import '@licium/editor-plugin-code-syntax-highlight/dist/toastui-editor-plugin-code-syntax-highlight.css';
|
|
157
160
|
|
|
158
161
|
// Import prismjs
|
|
159
162
|
import Prism from 'prismjs';
|
|
160
163
|
|
|
161
|
-
import Editor from '@
|
|
162
|
-
import codeSyntaxHighlight from '@
|
|
164
|
+
import Editor from '@licium/editor';
|
|
165
|
+
import codeSyntaxHighlight from '@licium/editor-plugin-code-syntax-highlight';
|
|
163
166
|
|
|
164
167
|
const viewer = Editor.factory({
|
|
165
168
|
// ...
|
|
@@ -172,7 +175,7 @@ const viewer = Editor.factory({
|
|
|
172
175
|
|
|
173
176
|
### Include Files
|
|
174
177
|
|
|
175
|
-
To use the plugin, the CDN files(CSS, Script) of `@
|
|
178
|
+
To use the plugin, the CDN files(CSS, Script) of `@licium/editor` must be included.
|
|
176
179
|
|
|
177
180
|
### Create Instance
|
|
178
181
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@licium/editor-plugin-code-syntax-highlight",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.5",
|
|
4
4
|
"description": "TOAST UI Editor : Code Syntax Highlight Plugin",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"nhn",
|
|
@@ -24,11 +24,11 @@
|
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"repository": {
|
|
26
26
|
"type": "git",
|
|
27
|
-
"url": "https://github.com/
|
|
27
|
+
"url": "https://github.com/natorus87/tui.editor.git",
|
|
28
28
|
"directory": "plugins/code-syntax-highlight"
|
|
29
29
|
},
|
|
30
30
|
"bugs": {
|
|
31
|
-
"url": "https://github.com/
|
|
31
|
+
"url": "https://github.com/natorus87/tui.editor/issues"
|
|
32
32
|
},
|
|
33
33
|
"homepage": "https://ui.toast.com",
|
|
34
34
|
"browserslist": "last 2 versions, not ie <= 10",
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2020 NHN Cloud Corp.
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in
|
|
13
|
-
all copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
-
THE SOFTWARE.
|