chore(ckeditor5-keyboard-marker): integrate rest of the files

This commit is contained in:
Elian Doran 2025-05-04 14:58:25 +03:00
parent 2a966e7fd8
commit dad7e3e408
No known key found for this signature in database
12 changed files with 68 additions and 293 deletions

View File

@ -1,16 +0,0 @@
# Configurations to normalize the IDE behavior.
# http://editorconfig.org/
root = true
[*]
indent_style = tab
tab_width = 4
charset = utf-8
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
[package.json]
indent_style = space
tab_width = 2

View File

@ -1,12 +0,0 @@
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/* eslint-env node */
'use strict';
module.exports = {
extends: 'ckeditor5'
};

View File

@ -1,18 +0,0 @@
* text=auto
*.htaccess eol=lf
*.cgi eol=lf
*.sh eol=lf
*.css text
*.htm text
*.html text
*.js text
*.json text
*.php text
*.txt text
*.md text
*.png -text
*.gif -text
*.jpg -text

View File

@ -1,106 +0,0 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
*.lcov
# nyc test coverage
.nyc_output
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# TypeScript v1 declaration files
typings/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env
.env.test
# parcel-bundler cache (https://parceljs.org/)
.cache
# Next.js build output
.next
# Nuxt.js build / generate output
.nuxt
dist
# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless/
# FuseBox cache
.fusebox/
# DynamoDB Local files
.dynamodb/
# TernJS port file
.tern-port
test

View File

@ -1,3 +0,0 @@
{
"extends": "stylelint-config-ckeditor5"
}

View File

@ -1,58 +0,0 @@
[![npm](https://img.shields.io/npm/dm/@mlewand/ckeditor5-keyboard-marker.svg?style=flat-square)](https://www.npmjs.org/package/@mlewand/ckeditor5-keyboard-marker)
# CKEditor 5 keyboard marker
This plugin adds support for the keyboard input element (`<kbd>`) to CKEditor 5.
![Keyboard marker example](assets/demo.gif)
## Installation
* Follow the [Creating custom builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/development/custom-builds.html) 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:
```js
'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'
};
```

View File

@ -1,56 +0,0 @@
{
"name": "@mlewand/ckeditor5-keyboard-marker",
"version": "1.0.2",
"description": "This plugin adds support for the keyboard input element (`<kbd>`) to CKEditor 5.",
"keywords": [
"ckeditor",
"ckeditor5",
"ckeditor 5"
],
"peerDependencies": {
"@ckeditor/ckeditor5-core": ">=19.0.0",
"@ckeditor/ckeditor5-ui": ">=19.0.0",
"@ckeditor/ckeditor5-basic-styles": ">=19.0.0"
},
"devDependencies": {
"eslint": "^5.5.0",
"eslint-config-ckeditor5": "^2.0.0",
"husky": "^1.3.1",
"lint-staged": "^7.0.0",
"stylelint": "^11.1.1",
"stylelint-config-ckeditor5": "^1.0.0"
},
"engines": {
"node": ">=10.0.0",
"npm": ">=5.7.1"
},
"author": "Marek Lewandowski",
"license": "GPL-3.0",
"homepage": "https://github.com/mlewand/ckeditor5-keyboard-marker",
"bugs": "https://github.com/mlewand/ckeditor5-keyboard-marker/issues",
"repository": {
"type": "git",
"url": "https://github.com/mlewand/ckeditor5-keyboard-marker.git"
},
"files": [
"src",
"icons"
],
"scripts": {
"lint": "eslint --quiet '**/*.js'",
"stylelint": "stylelint --quiet --allow-empty-input 'theme/**/*.css' 'docs/**/*.css'"
},
"lint-staged": {
"**/*.js": [
"eslint --quiet"
],
"**/*.css": [
"stylelint --quiet --allow-empty-input"
]
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
}
}

View File

@ -1,6 +0,0 @@
Software License Agreement
==========================
Copyright (c) 2025. All rights reserved.
Licensed under the terms of [MIT license](https://opensource.org/licenses/MIT).

View File

@ -1,21 +1,24 @@
@triliumnext/ckeditor5-keyboard-marker # CKEditor 5 keyboard marker
======================================
This package was created by the [ckeditor5-package-generator](https://www.npmjs.com/package/ckeditor5-package-generator) package. This plugin adds support for the keyboard input element (`<kbd>`) to CKEditor 5.
![Keyboard marker example](demo.gif)
## Table of contents ## Table of contents
* [Developing the package](#developing-the-package) - [CKEditor 5 keyboard marker](#ckeditor-5-keyboard-marker)
* [Available scripts](#available-scripts) - [Table of contents](#table-of-contents)
* [`start`](#start) - [Developing the package](#developing-the-package)
* [`test`](#test) - [Available scripts](#available-scripts)
* [`lint`](#lint) - [`start`](#start)
* [`stylelint`](#stylelint) - [`test`](#test)
* [`build:dist`](#builddist) - [`lint`](#lint)
* [`translations:synchronize`](#translationssynchronize) - [`stylelint`](#stylelint)
* [`translations:validate`](#translationsvalidate) - [`build:dist`](#builddist)
* [`ts:build` and `ts:clear`](#tsbuild-and-tsclear) - [`translations:synchronize`](#translationssynchronize)
* [License](#license) - [`translations:validate`](#translationsvalidate)
- [`ts:build` and `ts:clear`](#tsbuild-and-tsclear)
- [Installation](#installation)
## Developing the package ## Developing the package
@ -134,8 +137,53 @@ npm run translations:validate
These scripts compile TypeScript and remove the compiled files. They are used in the aforementioned life cycle scripts, and there is no need to call them manually. These scripts compile TypeScript and remove the compiled files. They are used in the aforementioned life cycle scripts, and there is no need to call them manually.
## License ## Installation
The `@triliumnext/ckeditor5-keyboard-marker` package is available under [MIT license](https://opensource.org/licenses/MIT). * Follow the [Creating custom builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/development/custom-builds.html) 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).
However, it is the default license of packages created by the [ckeditor5-package-generator](https://www.npmjs.com/package/ckeditor5-package-generator) package and can be changed. An example configuration:
```js
'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'
};
```

View File

Before

Width:  |  Height:  |  Size: 121 KiB

After

Width:  |  Height:  |  Size: 121 KiB

View File

@ -23,7 +23,9 @@
"./browser/*": null, "./browser/*": null,
"./package.json": "./package.json" "./package.json": "./package.json"
}, },
"license": "MIT", "author": "Marek Lewandowski",
"license": "GPL-3.0",
"homepage": "https://github.com/mlewand/ckeditor5-keyboard-marker",
"engines": { "engines": {
"node": ">=18.0.0", "node": ">=18.0.0",
"npm": ">=5.7.1" "npm": ">=5.7.1"