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

Update readme

Browse Source
This commit is contained in:
Sauli Anto 2019-10-01 18:18:13 +03:00
parent e5e78962f0
commit 18c3e58128
1 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,11 +1,9 @@
# CKEditor 5 mathematical feature # CKEditor 5 mathematical feature
This is the best TeX-based mathematical plugin for CKEditor 5. You can use it to insert, edit and view mathematical equation and formulas. This plugin supports MathJax, KaTeX and custom typesetting engines. This is the best* TeX-based mathematical plugin for CKEditor 5. You can use it to insert, edit and view mathematical equation and formulas. This plugin supports MathJax, KaTeX and custom typesetting engines.
## Demo (todo) ## Examples
[Link to classic editor demo](https://www.example.com) [Link to examples repository](https://github.com/isaul32/ckeditor5-math-examples)
[Link to inline editor demo](https://www.example.com)
## Installation ## Installation
Install plugin with NPM or Yarn Install plugin with NPM or Yarn
@ -74,9 +72,9 @@ InlineEditor.defaultConfig = {
} }
} }
``` ```
- __equation__ is equation in TeX format without delimiters - __equation__ is equation in TeX format without delimiters.
- __element__ is DOM element reserved for rendering - __element__ is DOM element reserved for rendering.
- __display__ is boolean. Typesetting should be inline when false - __display__ is boolean. Typesetting should be inline when false.
### Plugin options ### Plugin options
@ -103,14 +101,35 @@ Supported input and output formats are:
<span class="math-tex">\[ \sqrt{\frac{a}{b}} \]</span> <span class="math-tex">\[ \sqrt{\frac{a}{b}} \]</span>
``` ```
### Math paste support ### Paste support
It's possible to paste equations in mathtex by using __delimiters__. For example:
- __\\(__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\)__ (inline mode) #### Plain TeX paste
- __\\[__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\]__ (display mode) Paste equations with __delimiters__. For example:
__\\[__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\]__
or
__\\(__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\)__
#### Paste support from Microsoft Word
Use [__paste from office__](https://github.com/isaul32/ckeditor5-paste-from-office) fork instead of offical.
Install paste from office fork
`npm install @ckeditor/ckeditor5-paste-from-office@github:isaul32/ckeditor5-paste-from-office --save-dev`
```js
import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
import Mathematics from 'ckeditor5-math/src/math';
// ...
InlineEditor.builtinPlugins = [
// ...
PasteFromOffice,
Mathematics
];
```
## Todo ## Todo
- Convert equations to mathtex when paste document from word
- Fix KaTex preview - Fix KaTex preview
- Make better way to import lark theme for plugin
- MathML input and output when using MathJax version 3 - MathML input and output when using MathJax version 3
- Make tests - Make tests
[*] at least in my opinion