Code Tool for CodeX Editor 2.0
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
.eslintrc
.gitignore
.jshintrc
.postcssrc
.stylelintrc
LICENSE
README.md
package-lock.json
package.json
webpack.config.js

README.md

Code Tool for CodeX Editor

Code Tool for the CodeX Editor allows to include code examples in your articles.

Installation

Install via NPM

Get the package

npm i --save-dev codex.editor.code

Include module at your application

const CodeTool = require('codex.editor.code');

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/codex.editor.code@2.0.0

Require this script on a page with CodeX Editor.

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

Usage

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

var editor = CodexEditor({
  ...
  
  tools: {
    ...
    code: CodeTool,
  }
  
  ...
});

Config Params

Field Type Description
placeholder string Code Tool's placeholder string

Output data

This Tool returns code.

{
    "type" : "code",
    "data" : {
        "code": "body {\n font-size: 14px;\n line-height: 16px;\n}",
    }
}