# @editorjs/marker

> Marker Tool for Editor.js

Latest version **1.4.0** (published 2023-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @editorjs/marker
pnpm add @editorjs/marker
yarn add @editorjs/marker
bun add @editorjs/marker
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2023-11-14 |
| First published | 2019-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Author | CodeX |
| Maintainers | codex-team |
| Keywords | codex editor, marker, editor.js, editorjs |

## Links

- npm: https://www.npmjs.com/package/@editorjs/marker
- Repository: https://github.com/editor-js/marker
- npm.io page: https://npm.io/package/@editorjs/marker

## Dependencies (1)

- [@codexteam/icons](https://npm.io/package/@codexteam/icons.md) ^0.0.5

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.4.0 (latest) — 2023-11-14
- 1.3.0 — 2022-11-30
- 1.2.2 — 2019-11-30
- 1.2.1 — 2019-06-21
- 1.2.0 — 2019-03-02

## README

![](https://badgen.net/badge/Editor.js/v2.0/blue)

# Marker Tool

Marker Tool for highlighting text-fragments for the [Editor.js](https://editorjs.io).

![](assets/example.gif)

## Installation

Get the package

```shell
yarn add @editorjs/marker
```

Include module at your application

```javascript
import Marker from '@editorjs/marker';
```

Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/marker@latest)

## Usage

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

```javascript
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.

```json
{
    "type" : "text",
    "data" : {
        "text" : "Create a directory for your module, enter it and run <mark class=\"cdx-marker\">npm init</mark> command."
    }
}
```

---
_Source: https://npm.io/package/@editorjs/marker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._