From a1a23bf26dc0e142a7af3f7774434daae64e8d08 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 17 Mar 2024 12:36:37 -0500 Subject: [PATCH 1/4] chore: Typo fixes --- CHANGELOG.md | 2 +- ckeditor5-metadata.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09e7026..1349103 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -419,7 +419,7 @@ ## [22.0.0](https://github.com/isaul32/ckeditor5-math/compare/v21.0.0...v22.0.0) (2020-08-29) -- Seperate schema to display and inline. +- Separate schema to display and inline. ### Bug fixes diff --git a/ckeditor5-metadata.json b/ckeditor5-metadata.json index 8514f03..b8f844d 100644 --- a/ckeditor5-metadata.json +++ b/ckeditor5-metadata.json @@ -3,7 +3,7 @@ { "name": "Math", "className": "Math", - "description": "Adds mathematical formulars to the editor.", + "description": "Adds mathematical formulas to the editor.", "path": "src/math.js", "uiComponents": [ { From 08c3633231095412ce5e824c21c791f017f9f642 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 17 Mar 2024 12:29:26 -0500 Subject: [PATCH 2/4] docs(README): Note TypeScript and DLL-build support --- README.md | 39 ++------------------------------------- 1 file changed, 2 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 8ebd14c..a0bafe9 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ ckeditor5-math is a TeX-based mathematical plugin for CKEditor 5. You can use it ## Features +- Written in TypeScript (as of v41.2.1) +- DLL build support (as of v36.0.3) - TeX syntax - Inline and display equations - Preview view @@ -267,43 +269,6 @@ CKEditor5.editorInline.InlineEditorEditor My solution for this is use rendering element outside of CKEditor DOM and place it to right place by using absolute position. Alternative solution could be using iframe, but then typesetting engine's scripts and styles have to copy to child document. -## TypeScript users - -ckeditor5-math does not have typings yet. TypeScript builds of CKEditor will see -this: - -```sh -src/ckeditor.ts:63:18 - error TS7016: Could not find a declaration file for module '@isaul32/ckeditor5-math/src/math'. -'/path/to/your/project/node_modules/@isaul32/ckeditor5-math/src/math.js' implicitly has an 'any' type. - -Try `npm i --save-dev @types/isaul32__ckeditor5-math` if it exists or add a new declaration (.d.ts) file containing -`declare module '@isaul32/ckeditor5-math/src/math';` -``` - -### Workaround for typings - -1. Create a `d.ts` declaration file, e.g. `typings/ckeditor5-math.d.ts` - - ```typescript - declare module '@isaul32/ckeditor5-math'; - declare module '@isaul32/ckeditor5-math/src/math'; - declare module '@isaul32/ckeditor5-math/src/autoformatmath'; - ``` -2. In your [`tsconfig.json`](https://www.typescriptlang.org/tsconfig)'s - root-level [`include`](https://www.typescriptlang.org/tsconfig#include) - option, make sure your declaration file is covered, e.g. - - ```json - { - "extends": "ckeditor5/tsconfig.json", - "include": [ - "src", - "typings", - "../../typings" - ] - } - ``` - ## Development Contributions, improvements and bug fixes are welcome. To aid in this, try out From a13e2344c53709fb665f42ff247423b7f1258ded Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 17 Mar 2024 12:33:16 -0500 Subject: [PATCH 3/4] docs(README): Format with prettier --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index a0bafe9..e5baefc 100644 --- a/README.md +++ b/README.md @@ -161,19 +161,19 @@ InlineEditor.defaultConfig = { - `katexRenderOptions` - pass [options](https://katex.org/docs/options.html). - ```js - InlineEditor.defaultConfig = { - // ... - math: { - engine: 'katex' - katexRenderOptions: { - macros: { - "\\neq": "\\mathrel{\\char`≠}", - }, - }, - } - } - ``` + ```js + InlineEditor.defaultConfig = { + // ... + math: { + engine: 'katex' + katexRenderOptions: { + macros: { + "\\neq": "\\mathrel{\\char`≠}", + }, + }, + } + } + ``` **Custom typesetting** From 7b416ce20d70edbad7ac351ca8b75efbb5fe2a6e Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sun, 17 Mar 2024 12:32:19 -0500 Subject: [PATCH 4/4] Tag v41.2.2 (README update from #133) --- CHANGELOG.md | 13 +++++++++++-- package.json | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1349103..e625340 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,10 +4,19 @@ - Add latest changes here +## [41.2.2](https://github.com/isaul32/ckeditor5-math/compare/v41.2.1...v41.2.2) (2024-03-17) + +- README updates ([#133](https://github.com/isaul32/ckeditor5-math/pull/133)): + + - Note plugin supports DLL-based builds and is in TypeScript. + - Remove old TypeScript workaround sections. + +- Chore: Typo fixes ([#133](https://github.com/isaul32/ckeditor5-math/pull/133)) + ## [41.2.1](https://github.com/isaul32/ckeditor5-math/compare/v41.2.0...v41.2.1) (2024-03-17) -- Rewritten in TypeScript, credit @fedemp - ([#130](https://github.com/isaul32/ckeditor5-math/pull/130)). +- Rewritten in TypeScript, credit @fedemp + ([#130](https://github.com/isaul32/ckeditor5-math/pull/130)). ## [41.2.0](https://github.com/isaul32/ckeditor5-math/compare/v41.1.0...v41.2.0) (2024-03-08) diff --git a/package.json b/package.json index 1ed2cb7..54b602f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@isaul32/ckeditor5-math", - "version": "41.2.1", + "version": "41.2.2", "description": "Math feature for CKEditor 5.", "keywords": [ "ckeditor",