editor-js / inline-code

Inline-Code Tool for Editor.js 2.0
MIT License
46 stars 25 forks source link
code codex codex-editor inline-tool plugin

InlineCode Tool

Inline Tool for marking code-fragments for the Editor.js.

Installation

Get the package

yarn add @editorjs/inline-code

Include module at your application

import InlineCode from '@editorjs/inline-code';

Optionally, you can load this tool from CDN JsDelivr CDN

Usage

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

var editor = EditorJS({
  ...

  tools: {
    ...
    inlineCode: {
      class: InlineCode,
      shortcut: 'CMD+SHIFT+M',
    },
  },

  ...
});

Config Params

This Tool has no config params

Output data

Marked text will be wrapped with a span tag with an inline-code class.

{
    "type" : "text",
    "data" : {
        "text" : "Create a directory for your module, enter it and run <span class=\"inline-code\">npm init</span> command."
    }
}