Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.02 KB

README.md

File metadata and controls

62 lines (42 loc) · 1.02 KB

Subscript Tool

Subscript Tool for marking text-fragments for the Editor.js.

Installation

Install via NPM

Get the package

npm i --save-dev editorjs2-subscript

Include module at your application

const Subscript = require('editorjs2-subscript');

Download to your project's source dir

  1. Upload folder dist from repository
  2. Add dist/bundle.js file to your page.

Usage

Add a new Tool to the tools property of the Editor.js initial config.

var editor = EditorJS({
  ...
  
  tools: {
    ...
    subscript: {
      class: Subscript
    },
  },
  
  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a sub tag with an cdx-subscript class.

{
    "type" : "text",
    "data" : {
        "text" : "This is test<sub class='cdx-subscript'>text</sub>."
    }
}