Core development

If you want to help improving Editor.js, follow this guide to prepare local environment and start building.

We have a special Telegram-chat for core contributors where you can discuss any problems.

Before starting

Make sure that you have installed Node.js environment and Yarn package manager. Otherwise you should install them.

You also need Git installed. Check out Atlassian's guide «Install GIt».

Clone the repository

Firstly you need to get sources. Clone the repository via command line.

git clone

Or use buttons on the GitHub page.

Then go to the project's directory.

cd editor.js/

Install dependencies

Get required dependencies by the following command.

yarn install

Then pull submodules.

yarn pull_tools

Ok, you are ready.


Use the following command to build Editor.js. 

yarn build
Use this command before commit changes.

On local environment you can run build command in development mode with a watch flag. This way main bundle will be rebuilt on changes automatically.

yarn build:dev


Open file example/example-dev.html in browser. Editor and Tools will be loaded from local scripts.

Git conventions

To publish some changes to Editorjs, please follow these steps:

  1. Make sure you have create or find Issue describes a problem that you resolve.
  2. Create a branch for your changes. We recommend to use slash-separated naming convention. For example: hotfix/issue413-readme-changes or feature/issue413-new-inline-toolbar-style
  3. Make your changes.
  4. Increment a patch or minor version with postfix -rc*.*.* in package.json file. For example: 2.19.0-rc0.1.0.
  5. Commit your changes.
  6. Open Pull Request to next branch.
  7. In a PR's description, tell about changes you make and attach corresponded issue.