ckeditor5-math-preview

    8.0.0 • Public • Published

    ckeditor5-math-preview

    npm version Dependency Status devDependency Status

    About

    This is a plugin for ckeditor 5. When clicking on a latex math expression, a popup is shown that displays the expression rendered with MathJax or KaTeX.

    Demo

    Check this fiddle: https://jsfiddle.net/centaur54dev/ra7qcLzb/

    Install

    Install using NPM:

    npm install ckeditor5-math-preview

    To add the functionality of this plugin you should make a custom build of the editor. Follow the instructions here.

    To load the plugin, configure ckeditor (e.g. edit file ckeditor.js) like this:

    Import plugin

    import MathpreviewPlugin from 'ckeditor5-math-preview/src/mathpreview';
    

    Configure build

    Assuming that the build is based on Classic Editor:

    export default class ClassicEditor extends ClassicEditorBase {}
    
    // Plugins to include in the build.
    ClassicEditor.builtinPlugins = [
    	...
    	MathpreviewPlugin,
    	...
    ],
    
    ClassicEditor.defaultConfig = {
    	toolbar: {
    		items: [
    			...
    			'mathpreview',
    			...
    			]
    	},
    
    	MathPreview : {
    		//configuration options for the math-preview plugin
    		engine: 'mathjax' //or 'katex'
    	},
    
    
    
    	...OTHER OPTIONS
    };
    

    Note: the MathPreview configuration is optional. If not defined the rendering defaults to MathJax.

    Use

    A toolbar button is added, which functions as an on/off switch for the plugin functionality. Type some math formulas in latex in the editor using either the \[ \] or the \( \) markers, e.g. \[x^2+\frac{1}{x}=0\]. When clicking anywhere in the formula, a popup appears and the formula is rendered. The rendering updates itself on formula modification, on the fly.

    The plugin expects MathJax or KaTeX to be loaded and configured.

    Install

    npm i ckeditor5-math-preview

    DownloadsWeekly Downloads

    50

    Version

    8.0.0

    License

    MIT

    Unpacked Size

    26.1 kB

    Total Files

    16

    Last publish

    Collaborators

    • avatar