From 2e9c7426f9c9eac41389f38cb94dd0a0f259d258 Mon Sep 17 00:00:00 2001 From: Kunal Mandalia Date: Thu, 25 Jul 2024 15:34:21 +0100 Subject: [PATCH 1/2] docs: closer to native English --- example/example-popup.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/example/example-popup.html b/example/example-popup.html index e59fd6cd7..b7a41bf93 100644 --- a/example/example-popup.html +++ b/example/example-popup.html @@ -31,10 +31,10 @@

Base concepts

- Editor.js is a block-style editor for rich media stories. It outputs clean data in JSON instead of heavy HTML markup. And more important thing is that Editor.js is designed to be API extendable and pluggable. + Editor.js is a block-style editor for rich media stories. It outputs clean data in JSON instead of heavy HTML markup. Importantly, Editor.js is designed to be API extendable and pluggable.

- So there are a few key features: + Key features:

- What does it mean block-styled + What does block-styled mean

- In other editors, the workspace is provided by single contenteditable element in where you can create different HTML markup. All of us saw permanent bugs with moving text fragments or scaling images, while page parts are jumping and twitches. Or highlighting big parts of the text in the case when you just want to make few words to be a heading or bold. + In other editors, the workspace is provided by a single contenteditable element in which you can create and modify HTML markup. This resulted in bugs with moving text fragments or scaling images, while page parts are jumping and twitches. Or highlighting big parts of the text in the case when you just want to make few words to be a heading or bold.

The Editor.js workspace consists of separate Blocks: paragraphs, headings, images, lists, quotes, etc. Each of them is an independent contenteditable element (or more complex structure) provided by Plugin and united by Editor's Core.

- At the same time, most useful features as arrow-navigation, copy & paste, cross block selection, and others works almost as in the familiar editors. + Useful editor features such as arrow-navigation, copy & paste, cross block selection, and others work as they do in popular editors.

What is clean data

- But the more interesting thing is, as mentioned above, that Editor.js returns clean data instead of HTML-markup. Take a look at the example. + Editor.js returns clean data instead of HTML-markup. Take a look at the example.

If our entry consists of few paragraphs and a heading, in popular Medium editor after saving we will have something like this: @@ -72,7 +72,7 @@

Also, the clean data can be useful for backend processing: sanitizing, validation, injecting an advertising or other stuff, extracting Headings, make covers for social networks from Image Blocks, and other.

- API pluggable? + API pluggable

A key value of the Editor is the API. All main functional units of the editor — Blocks, Inline Formatting Tools, Block Tunes — are provided by external plugins that use Editor's API. @@ -84,7 +84,7 @@

At the same time, API is created to be easy-to-understand and simple-to-use.

- Open Source, so? + Open Source

Editor.js is more than just an editor. It is a big open-source community of developers and contributors. Anyone can suggest an improvement or a bug fix. Anyone can create new cool API features and plugins. From 263cefe2f28f891d155d43d0a49b365c95098fa0 Mon Sep 17 00:00:00 2001 From: Kunal Mandalia Date: Thu, 25 Jul 2024 15:42:36 +0100 Subject: [PATCH 2/2] docs: small edits, reword --- example/example-popup.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/example/example-popup.html b/example/example-popup.html index b7a41bf93..813aeaf4b 100644 --- a/example/example-popup.html +++ b/example/example-popup.html @@ -42,10 +42,10 @@

Base concepts

  • Open source
  • - What does block-styled mean + What does block-style mean

    - In other editors, the workspace is provided by a single contenteditable element in which you can create and modify HTML markup. This resulted in bugs with moving text fragments or scaling images, while page parts are jumping and twitches. Or highlighting big parts of the text in the case when you just want to make few words to be a heading or bold. + In other editors, the workspace is provided by a single contenteditable element in which you can create and modify HTML markup. This results in bugs with moving text fragments or scaling images, while page parts are jumping and twitches. Or highlighting big parts of the text in the case when you just want to make few words to be a heading or bold.

    The Editor.js workspace consists of separate Blocks: paragraphs, headings, images, lists, quotes, etc. Each of them is an independent contenteditable element (or more complex structure) provided by Plugin and united by Editor's Core.