Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-09-16 16:27:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): Use new package name

Browse Source
This commit is contained in:
Tony Narlock 2023-04-03 07:01:23 -05:00
parent 6bdbf1d2d3
commit 328569e13c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,4 +1,4 @@
# CKEditor 5 mathematical feature · [![GitHub license](https://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/isaul32/ckeditor5-math/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/ckeditor5-math.svg?style=flat)](https://www.npmjs.com/package/ckeditor5-math) # CKEditor 5 mathematical feature · [![GitHub license](https://img.shields.io/badge/license-ISC-blue.svg)](https://github.com/isaul32/ckeditor5-math/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/@isaul32/ckeditor5-math.svg?style=flat)](https://www.npmjs.com/package/@isaul32/ckeditor5-math)
ckeditor5-math is a TeX-based mathematical plugin for CKEditor 5. You can use it to insert, edit, and view mathematical equations and formulas. This plugin supports [MathJax], [KaTeX] and custom typesetting engines. ckeditor5-math is a TeX-based mathematical plugin for CKEditor 5. You can use it to insert, edit, and view mathematical equations and formulas. This plugin supports [MathJax], [KaTeX] and custom typesetting engines.
@ -65,15 +65,15 @@ Use official classic or inline build as a base:
Install plugin with NPM or Yarn Install plugin with NPM or Yarn
`npm install ckeditor5-math --save-dev` `npm install @isaul32/ckeditor5-math --save-dev`
`yarn add ckeditor5-math --dev` `yarn add @isaul32/ckeditor5-math --dev`
Add import into ckeditor.js file Add import into ckeditor.js file
```js ```js
import Math from 'ckeditor5-math/src/math'; import Math from '@isaul32/ckeditor5-math/src/math';
import AutoformatMath from 'ckeditor5-math/src/autoformatmath'; import AutoformatMath from '@isaul32/ckeditor5-math/src/autoformatmath';
``` ```
Add it to built-in plugins Add it to built-in plugins
@ -108,7 +108,7 @@ InlineEditor.defaultConfig = {
Use the [official DLL build](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/dll-builds.html) and additionally load the math plugin: Use the [official DLL build](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/dll-builds.html) and additionally load the math plugin:
```html ```html
<script src="path/to/node_modules/isaul32/ckeditor5-math/build/math.js"></script> <script src="path/to/node_modules/@isaul32/ckeditor5-math/build/math.js"></script>
<script> <script>
CKEditor5.editorClassic.ClassicEditor CKEditor5.editorClassic.ClassicEditor
.create(editorElement, { .create(editorElement, {
@ -237,7 +237,7 @@ Add following lines into your build
```js ```js
// ... // ...
import AutoformatMath from 'ckeditor5-math/src/autoformatmath'; import AutoformatMath from '@isaul32/ckeditor5-math/src/autoformatmath';
InlineEditor.builtinPlugins = [ InlineEditor.builtinPlugins = [
// ... // ...
@ -248,7 +248,7 @@ InlineEditor.builtinPlugins = [
or use it with DLL build or use it with DLL build
```html ```html
<script src="path/to/node_modules/isaul32/ckeditor5-math/build/math.js"></script> <script src="path/to/node_modules/@isaul32/ckeditor5-math/build/math.js"></script>
<script> <script>
CKEditor5.editorInline.InlineEditorEditor CKEditor5.editorInline.InlineEditorEditor
.create(editorElement, { .create(editorElement, {