Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated some wording. #1044

Merged
merged 6 commits into from
Mar 3, 2020
Merged

updated some wording. #1044

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
74fdc91
Release/2.16.1 (#990)
neSpecc Dec 7, 2019
737ba2a
Update CHANGELOG.md
neSpecc Dec 7, 2019
34ffbbe
updated some wording.
drbe4t Feb 24, 2020
dd5d816
Merge branch 'release/2.17' into pr/1044
neSpecc Mar 3, 2020
5df91d5
Update installation.md
neSpecc Mar 3, 2020
eabae36
Update CHANGELOG.md
neSpecc Mar 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ There are few steps to run Editor.js on your site.

Firstly you need to get Editor.js itself. It is a [minified script](../dist/editor.js) with minimal available

Choose the most usable method of getting Editor for you.
Choose the most usable method of getting an Editor for you.

- Node package
- Source from CDN
- Local file from project
- Local file from a project

### Node.js

Expand Down Expand Up @@ -52,11 +52,11 @@ Copy [editor.js](../dist/editor.js) file to your project and load it.

## Load Tools

Each Block at the Editor.js represented by [Tools](tools.md). There are simple external scripts with own logic. Probably you want to use several Block Tools that should be connected.
Each Block at the Editor.js represented by [Tools](tools.md). There are simple external scripts with their own logic. You'll probably want to use several Block Tools that should be connected.

For example check out our [Header](https://github.com/editor-js/header) Tool that represents heading blocks.
For example, check out our [Header](https://github.com/editor-js/header) Tool that represents heading blocks.

You can install Header Tool via the same ways as an Editor (Node.js, CDN, local file).
You can install the Header Tool via the same ways as an Editor (Node.js, CDN, local file).

Check [Editor.js's community](https://github.com/editor-js/) to see Tools examples.

Expand All @@ -69,7 +69,7 @@ Check [Editor.js's community](https://github.com/editor-js/) to see Tools exampl
## Create Editor instance

Create an instance of Editor.js and pass [Configuration Object](../src/types-internal/editor-config.ts).
Minimal params is a `holderId`, `tools` list and `initialBlock` marker.
At least the `holderId` option is required.

```html
<div id="editorjs"></div>
Expand Down Expand Up @@ -115,9 +115,9 @@ var editor = new EditorJS({

## Ready callback

Editor.js needs a bit time to initialize. It is an asynchronous action so it won't block execution of your main script.
Editor.js needs a bit of time to initialize. It is an asynchronous action so it won't block execution of your main script.

If you need to know when editor instance is ready you can use one of following ways:
If you need to know when the editor instance is ready you can use one of the following ways:

##### Pass `onReady` property to the configuration object.

Expand All @@ -136,9 +136,9 @@ var editor = new EditorJS({

#### Use `isReady` promise.

After you create new `EditorJS` object it contains `isReady` property.
It is a Promise object resolved when editor is ready to work and rejected otherwise.
If there is an error during initialization `isReady` promise will be rejected with error message.
After you create a new `EditorJS` object it will contain `isReady` property.
It is a Promise object that resolves when the editor will be ready to work and rejected otherwise.
If there is an error during initialization `isReady` promise will be rejected with an error message.

```javascript
var editor = new EditorJS();
Expand Down Expand Up @@ -179,7 +179,7 @@ editor.saver.save()

## Features

Also Editor.js provides useful methods to work with Editor's state.
Also, Editor.js provides useful methods to work with Editor's state.

```javascript
var editor = new EditorJS({
Expand Down