Skip to content
Marker Tool for Editor.js 2.0
Branch: master
Clone or download
gohabereg Feature/renaming (#4)
* Rename all occurences

* 1.2.0

* Update packages

* Rename repo

* Create .npmignore

* Update README.md
Latest commit 414c02a Mar 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Update README Aug 21, 2018
dist
src Feature/renaming (#4) Mar 2, 2019
.gitignore Update styles and .gitignore Aug 21, 2018
.npmignore Feature/renaming (#4) Mar 2, 2019
LICENSE Initial commit Aug 20, 2018
README.md Feature/renaming (#4) Mar 2, 2019
package.json
webpack.config.js
yarn.lock

README.md

Marker Tool

Marker Tool for highlighting text-fragments for the Editor.js.

Installation

Install via NPM

Get the package

npm i --save-dev @editorjs/marker

Include module at your application

const Marker = require('@editorjs/marker');

Download to your project's source dir

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

Load from CDN

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/@editorjs/marker@1.0.1

Require this script on a page with Editor.js.

<script src="..."></script>

Usage

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

var editor = EditorJS({
  ...
  
  tools: {
    ...
    Marker: {
      class: Marker,
      shortcut: 'CMD+SHIFT+M',
    }
  },
  
  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a mark tag with an cdx-marker class.

{
    "type" : "text",
    "data" : {
        "text" : "Create a directory for your module, enter it and run <mark class=\"cdx-marker\">npm init</mark> command."
    }
}
You can’t perform that action at this time.