https://github.com/aarkue/tiptap-math-extension
Math Extension for the TipTap Editor
https://github.com/aarkue/tiptap-math-extension
editor latex math tiptap tiptap-editor
Last synced: 2 months ago
JSON representation
Math Extension for the TipTap Editor
- Host: GitHub
- URL: https://github.com/aarkue/tiptap-math-extension
- Owner: aarkue
- License: mit
- Created: 2023-06-02T16:24:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T20:43:33.000Z (5 months ago)
- Last Synced: 2025-03-29T02:08:40.060Z (2 months ago)
- Topics: editor, latex, math, tiptap, tiptap-editor
- Language: TypeScript
- Homepage: https://aarkue.github.io/tiptap-math-extension/
- Size: 3.08 MB
- Stars: 66
- Watchers: 1
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Math/LaTeX Extension for the TipTap Editor
Use inline math expression / LaTeX directly in your editor!
[](https://www.npmjs.com/package/@aarkue/tiptap-math-extension)
[](https://www.npmjs.com/package/@aarkue/tiptap-math-extension)
[](https://www.npmjs.com/package/@aarkue/tiptap-math-extension)
## Usage
See the demo at `/example` for a quick introduction on how to use this package.
The **package is now available on NPM** as [**@aarkue/tiptap-math-extension**](https://www.npmjs.com/package/@aarkue/tiptap-math-extension).
It can be installed using `npm install @aarkue/tiptap-math-extension`.
To correctly render the LaTeX expressions, you will also need to include the **KaTeX CSS**.
If you are using [vite](https://vitejs.dev/) you can use `import "katex/dist/katex.min.css";` in the component which renders the tiptap editor.
This requires that you also install the `katex` npm package using `npm i katex` (https://www.npmjs.com/package/katex).
There are also different ways to include the CSS, for instance by using a CDN like `jsdelivr.net`. See https://katex.org/docs/browser for more information. Note, however, that only the CSS needs to be included manually, as the JS is already bundled with this plugin.
## Features
### Display Inline LaTeX
Writing a math expression surrounded by `$`-signs automatically creates a rendered LaTeX expression.
The delimiters are also configurable via the corresponding option.
To edit or delete the LaTeX, simply press backspace with the cursor placed before the expression.
The rendered LaTeX will disappear and the LaTeX source will become normal editable text again.
### Evaluate LaTeX Expression
**Note: Since version 1.2.0 this feature needs to be explicitly enabled**.
This can be done using the `evaluate` configuration option:
```typescript
const editor = useEditor({
extensions: [StarterKit, MathExtension.configure({ evaluation: true })],
content: "
Hello World!
",
});
```
Calculation results can be shown inline, using the [Evaluatex.js]([https://arthanzel.github.io/evaluatex/) library.
Define variables using the `:=` notation (e.g., `x := 120`).
Then, expressions can include this variable (e.g., `x \cdot 4=`).
End the calculating expressions with `=` to automatically show the computed result.
## Screenshots + Demo
Try out the demo directly online at [https://aarkue.github.io/tiptap-math-extension/](https://aarkue.github.io/tiptap-math-extension/)!
https://github.com/aarkue/tiptap-math-extension/assets/20766652/96f31846-d4a8-4cb2-b963-ff6da57daeb1
## Options
There are a few options available to configure the extension. See below for typescript definitions of all available options and their default value.
```typescript
export interface MathExtensionOption {
/** Evaluate LaTeX expressions */
evaluation: boolean;
/** Add InlineMath node type (currently required as inline is the only supported mode) */
addInlineMath: boolean;
/** KaTeX options to use for evaluation, see also https://katex.org/docs/options.html */
katexOptions?: KatexOptions;
/** Delimiters to auto-convert. Per default dollar-style (`dollar`) ($x_1$ and $$\sum_i i$$) are used.
*
* The `bracket` option corresponds to `\(x_1\)` and `\[\sum_i i \]`.
*
* Alternatively, custom inline/block regexes can be used.
* The inner math content is expected to be the match at index 1 (`props.match[1]`).
*/
delimiters?:
| "dollar"
| "bracket"
| {
inlineRegex?: string;
blockRegex?: string;
inlineStart?: string;
inlineEnd?: string;
blockStart?: string;
blockEnd?: string;
};
}
export const DEFAULT_OPTIONS: MathExtensionOption = { addInlineMath: true, evaluation: false, delimiters: "dollar" };
```
See https://katex.org/docs/options.html for a complete list of the available KaTeX options.
## Related or Used Projects
- [Tiptap Editor](https://github.com/ueberdosis/tiptap): The extensible editor for which this is an extension.
- [KaTeX](https://github.com/KaTeX/KaTeX): A LaTeX rendering engine for the web, used to render LaTeX expressions.
- [Evaluatex.js](https://github.com/arthanzel/evaluatex): Used to evaluate LaTeX expressions to a numeric value (e.g., `1 + (2 \cdot 3) = 7`).
- [Vite](https://github.com/vitejs/vite): Used to serve the example demo project.