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

Update readme

Browse Source
This commit is contained in:
Sauli Anto 2019-10-03 18:51:24 +03:00
parent 5e17cf15de
commit 379e1a6bef
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -51,7 +51,7 @@ Add import into ckeditor.js file
import Mathematics from 'ckeditor5-math/src/math'; import Mathematics from 'ckeditor5-math/src/math';
``` ```
Add it to builtinPlugins Add it to built-in plugins
```js ```js
InlineEditor.builtinPlugins = [ InlineEditor.builtinPlugins = [
@ -60,7 +60,7 @@ InlineEditor.builtinPlugins = [
]; ];
``` ```
__Add math button to toolbar__ and optional math config to default config __Add math button to toolbar__
```js ```js
InlineEditor.defaultConfig = { InlineEditor.defaultConfig = {
@ -73,7 +73,7 @@ InlineEditor.defaultConfig = {
}; };
``` ```
### Styles for Lark theme ### Styles for Lark theme
Copy __theme/ckeditor5-math__ folder from [https://github.com/isaul32/ckeditor5-theme-lark](https://github.com/isaul32/ckeditor5-theme-lark) to your lark theme repository or install __Copy theme/ckeditor5-math folder__ from [https://github.com/isaul32/ckeditor5-theme-lark](https://github.com/isaul32/ckeditor5-theme-lark) to your lark theme repository or install
`npm install @ckeditor/ckeditor5-theme-lark@https://github.com/isaul32/ckeditor5-theme-lark --save-dev` `npm install @ckeditor/ckeditor5-theme-lark@https://github.com/isaul32/ckeditor5-theme-lark --save-dev`
@ -96,9 +96,9 @@ InlineEditor.defaultConfig = {
### Available typesetting engines ### Available typesetting engines
__MathJax__ __MathJax__
- Tested by using version __latest 2.7__. - Tested by using __latest 2.7__
- Also has experimental (__CHTML__, __SVG__) support for __3.0.0__ or newer version. - Has experimental (__CHTML__, __SVG__) support for __3.0.0__ or newer version
- Use __\\( \\)__ delimiters for inline and __\\[ \\]__ delimiters for display - Use only __\\( \\)__ delimiters for inline and __\\[ \\]__ delimiters for display
[<img src="https://www.mathjax.org/badge/badge-square.svg" width="130" alt="KaTeX">](https://www.mathjax.org/) [<img src="https://www.mathjax.org/badge/badge-square.svg" width="130" alt="KaTeX">](https://www.mathjax.org/)
@ -123,7 +123,7 @@ 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.
- __preview__ is boolean. Preview Rendering when true. - __preview__ is boolean. Rendering in preview when true.
### Supported input and output formats ### Supported input and output formats
@ -142,12 +142,15 @@ Supported input and output formats are:
#### From plain text #### From plain text
Paste TeX equations with __delimiters__. For example: Paste TeX equations with __delimiters__. For example:
__\\[__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\]__ __\\[__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\]__
or or
__\\(__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\)__ __\\(__ x=\frac{-b\pm\sqrt{b^2-4ac}}{2a} __\\)__
#### From Microsoft Word #### From Microsoft Word
Use [__paste from office__](https://github.com/isaul32/ckeditor5-paste-from-office) fork instead of official. This feature is __experimental__ and might not work always (look source code). Use [__paste from office__](https://github.com/isaul32/ckeditor5-paste-from-office) fork instead of official. This feature is __experimental__ and might not work always (look source codes).
Install paste from office fork Install paste from office fork