@@ -15,10 +15,10 @@ Welcome to testing stage. Please, join a [public Telegram-chat](//t.me/codex_edi
15
15
- ` New ` Added ` onChange ` -callback, fired after any modifications at the Editor. See [ documentation] ( https://github.com/codex-team/codex.editor/blob/master/docs/installation.md#features ) .
16
16
- ` New ` New Inline Tool example — [ Marker] ( https://github.com/codex-editor/marker )
17
17
- ` New ` New Inline Tool example — [ Code] ( https://github.com/codex-editor/code )
18
- - ` New ` New [ CodeX Editor PHP] ( http://github.com/codex-team/codex.editor.backend ) — example of server-side implementation with HTML purifying and data validation.
19
- - ` Improvements ` - Improvements of Toolbar's position calculation.
18
+ - ` New ` New [ CodeX Editor PHP] ( http://github.com/codex-team/codex.editor.backend ) — example of server-side implementation with HTML purifying and data validation.
19
+ - ` Improvements ` - Improvements of Toolbar's position calculation.
20
20
- ` Improvements ` — Improved zero-configuration initialization.
21
- - and many little improvements.
21
+ - and many little improvements.
22
22
23
23
## Documentation
24
24
@@ -28,7 +28,7 @@ While we develop the new Documentation Site with all stuff, you can check some a
28
28
- [ How to use] ( docs/usage.md )
29
29
- [ How to create a Block Tool Plugin] ( docs/tools.md )
30
30
- [ How to create an Inline Tool Plugin] ( docs/tools-inline.md )
31
- - [ API for Tools] ( src/components/interfaces/ api.ts )
31
+ - [ API for Tools] ( docs/ api.md )
32
32
33
33
Sorry if we missed something. You can join a [ Telegram-chat] ( //t.me/codex_editor ) and ask a question.
34
34
@@ -38,8 +38,8 @@ Sorry if we missed something. You can join a [Telegram-chat](//t.me/codex_editor
38
38
39
39
## Basics
40
40
41
- CodeX Editor is a Block-Styled editor. Blocks is a structural units, of which the Entry is composed.
42
- For example, ` Paragraph ` , ` Heading ` , ` Image ` , ` Video ` , ` List ` are Blocks. Each Block is represented by a Plugin.
41
+ CodeX Editor is a Block-Styled editor. Blocks are structural units, of which the Entry is composed.
42
+ For example, ` Paragraph ` , ` Heading ` , ` Image ` , ` Video ` , ` List ` are Blocks. Each Block is represented by Plugin.
43
43
We have [ many] ( http://github.com/codex-editor ) ready-to-use Plugins and the [ simple API] ( docs/tools.md ) for creation new ones.
44
44
45
45
So how to use the Editor after [ Installation] ( docs/installation.md ) .
@@ -50,29 +50,29 @@ So how to use the Editor after [Installation](docs/installation.md).
50
50
51
51
52
52
![ ] ( https://github.com/codex-editor/list/raw/master/assets/example.gif )
53
-
53
+
54
54
- Select text fragment and apply a style or insert a link from the Inline Toolbar
55
55
56
56
![ ] ( https://capella.pics/7ccbcfcd-1c49-4674-bea7-71021468a1bd.jpg )
57
57
58
- - Use «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block
58
+ - Use «three-dots» button on the right to open Block Settings. From here, you can move and delete a Block
59
59
or apply Tool's settings, if it provided. For example, set a Heading level or List style.
60
60
61
- ![ ] ( https://capella.pics/01a55381-46cd-47c7-b92e-34765434f2ca.jpg )
61
+ ![ ] ( https://capella.pics/01a55381-46cd-47c7-b92e-34765434f2ca.jpg )
62
62
63
63
## Shortcuts
64
64
65
- We really appreciate shortcuts. So there are few presets.
65
+ We really appreciate shortcuts. So there are few presets.
66
66
67
- Action | Shortcut | Restrictions
67
+ Shortcut | Action | Restrictions
68
68
-- | -- | --
69
69
` TAB ` | Show/leaf a Toolbox. | On empty block
70
70
` SHIFT+TAB ` | Leaf back a Toolbox. | While Toolbox is opened
71
71
` ENTER ` | Create a Block | While Toolbox is opened and some Tool is selected
72
72
` CMD+B ` | Bold style | On selection
73
73
` CMD+I ` | Italic style | On selection
74
74
` CMD+K ` | Insert a link | On selection
75
-
75
+
76
76
Also we support shortcuts on the all type of Tools. Specify a shortcut with the Tools configuration. For example:
77
77
78
78
``` js
@@ -104,7 +104,7 @@ There are few steps to run CodeX Editor on your site.
104
104
105
105
## Load Editor's core
106
106
107
- Firstly you need to get CodeX Editor itself. It is a [ minified script] ( build/codex-editor.js ) with minimal available
107
+ Firstly you need to get CodeX Editor itself. It is a [ minified script] ( build/codex-editor.js ) with Editor's core and some default must-have tools.
108
108
109
109
Choose the most usable method of getting Editor for you.
110
110
@@ -120,7 +120,7 @@ Install the package via NPM or Yarn
120
120
npm i codex.editor --save-dev
121
121
```
122
122
123
- Include module at your application
123
+ Include module in your application
124
124
125
125
``` javascript
126
126
const CodexEditor = require (' codex.editor' );
@@ -164,7 +164,7 @@ Check [CodeX Editor's community](https://github.com/codex-editor) to see more re
164
164
165
165
## Create Editor instance
166
166
167
- Create an instance of CodeX Editor and pass [ Configuration Object] ( src/components/interfaces/ editor-config.ts) with ` holderId ` and tools list.
167
+ Create an instance of CodeX Editor and pass [ Configuration Object] ( types/configs/ editor-config.d. ts) with ` holderId ` and tools list.
168
168
169
169
``` html
170
170
<div id =" codex-editor" ></div >
@@ -217,7 +217,7 @@ editor.saver.save()
217
217
.then((savedData) => {
218
218
console.log(savedData);
219
219
});
220
- ` ` `
220
+ ` ` `
221
221
222
222
## Example
223
223
0 commit comments