File tree Expand file tree Collapse file tree 1 file changed +22
-6
lines changed Expand file tree Collapse file tree 1 file changed +22
-6
lines changed Original file line number Diff line number Diff line change @@ -32,17 +32,33 @@ It was built to be an improvement on :
32
32
33
33
---
34
34
35
- # Technical Info
35
+ ## Installation / use
36
+
37
+ ``` javascript
38
+ import EditorJS from ' @editorjs/editorjs' ;
39
+ import editorjsCodeflask from ' @calumk/editorjs-codeflask' ;
40
+
41
+ var editor = EditorJS ({
42
+ // ...
43
+ tools: {
44
+ ...
45
+ code : editorjsCodeflask
46
+ },
47
+ });
48
+ ```
49
+
36
50
37
51
## Data Format
38
52
The data imported/exported from the block is as follows:
39
53
40
- | Name | Description |
41
- | --------------- | ---------------------------------------------------------- |
42
- | code | The code that is displayed in the editor, with line breaks |
43
- | language | The programming language |
44
- | showlinenumbers | Will show/hide the line numbers (Default true) (WIP - [ Codeflask #132 ] ( https://github.com/kazzkiq/CodeFlask/issues/132 ) ) |
54
+ | Name | Description |
55
+ | -------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
56
+ | code | The code that is displayed in the editor, with line breaks |
57
+ | language (optional) | The programming language |
58
+ | showlinenumbers (optional) | Will show/hide the line numbers (Default true) (WIP - [ Codeflask #132 ] ( https://github.com/kazzkiq/CodeFlask/issues/132 ) ) |
59
+
45
60
61
+ Since language and linenumbers are optional, existing ``` code ``` blocks can safley use this plugin
46
62
47
63
48
64
You can’t perform that action at this time.
0 commit comments