Build your personal knowledge base with TriliumNext Notes
 
 
 
 
 
 
Go to file
Marek Lewandowski 0e9c40ecc7 Bumped CKEditor5 upstream package version. 2020-05-03 20:56:13 +07:00
assets Added installation steps in the readme file. 2020-04-10 00:53:28 +07:00
icons Initial implementation of the plugin. 2020-04-09 23:40:58 +07:00
src Changed the hotkey to `ctrl+alt+k` as `shift+alt+k` is buggy due to https://github.com/ckeditor/ckeditor5/issues/6594. 2020-04-10 00:40:55 +07:00
.editorconfig Added tools config. 2020-04-09 23:42:00 +07:00
.eslintrc.js Added tools config. 2020-04-09 23:42:00 +07:00
.gitattributes Added tools config. 2020-04-09 23:42:00 +07:00
.gitignore Initial commit 2020-04-09 23:09:24 +07:00
.stylelintrc Added tools config. 2020-04-09 23:42:00 +07:00
LICENSE Initial commit 2020-04-09 23:09:24 +07:00
README.md Added installation steps in the readme file. 2020-04-10 00:53:28 +07:00
package.json Bumped CKEditor5 upstream package version. 2020-05-03 20:56:13 +07:00

README.md

CKEditor 5 keyboard marker

This plugin adds support for the keyboard input element (<kbd>) to CKEditor 5.

Keyboard marker example

Installation

  • Follow the Creating custom builds guide.
  • Execute npm i @mlewand/ckeditor5-keyboard-marker --save (or yarn add @mlewand/ckeditor5-keyboard-marker)
  • Include the Kbd plugin and add kbd button to the toolbar (if desired).

An example configuration:

'use strict';

// The editor creator to use.
import ClassicEditorBase from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';

import EssentialsPlugin from '@ckeditor/ckeditor5-essentials/src/essentials';
import AutoformatPlugin from '@ckeditor/ckeditor5-autoformat/src/autoformat';
import BoldPlugin from '@ckeditor/ckeditor5-basic-styles/src/bold';
import ItalicPlugin from '@ckeditor/ckeditor5-basic-styles/src/italic';
import HeadingPlugin from '@ckeditor/ckeditor5-heading/src/heading';
import LinkPlugin from '@ckeditor/ckeditor5-link/src/link';
import ListPlugin from '@ckeditor/ckeditor5-list/src/list';
import ParagraphPlugin from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import RemoveFormat from '@ckeditor/ckeditor5-remove-format/src/removeformat';

import Kbd from '@mlewand/ckeditor5-keyboard-marker/src/Kbd';

export default class ClassicEditor extends ClassicEditorBase {}

// Plugins to include in the build.
ClassicEditor.builtinPlugins = [
	EssentialsPlugin,
	AutoformatPlugin,
	BoldPlugin,
	ItalicPlugin,
	HeadingPlugin,
	LinkPlugin,
	ListPlugin,
	ParagraphPlugin,
	RemoveFormat,

	Kbd
];

ClassicEditor.defaultConfig = {
	toolbar: [ 'heading', '|', 'bold', 'italic', 'kbd', 'removeFormat' ],

	// This value must be kept in sync with the language defined in webpack.config.js.
	language: 'en'
};