Core development

If you want to help improve Editor.js, follow this guide to prepare the 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.

• Node.js downloads page
• Yarn installation page

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 the command line.

Or use buttons on the GitHub page.

Then go to the project's directory.

Install dependencies

Get required dependencies by the following command.

Then pull submodules.

Ok, you are ready.

Building

Use the following command to build Editor.js. 

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.

Testing

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

Icons adding / changing

In case of adding or changing editor icons, it is recommended to use 24x24 svg icon size with the path made by stroke (center, 2px). Such an icon should be decreased to 20x20 then.

Consider using the CodeX Icons pack to unify all tools icons.

Git conventions

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

1. Make sure you have created or found an Issue that describes a problem that you resolve.
   
2. Create a branch for your changes. We recommend using a slash-separated naming convention. For example: hotfix/issue413-readme-changes or feature/issue413-new-inline-toolbar-style
3. Make your changes.
4. Commit your changes.
5. Open Pull Request to the next branch.
6. In a PR's description, tell about changes you make and attach corresponded issue.