tiptap-math v1.0.0

tiptap-math

A LaTeX extension for Tiptap

Getting Started

Installation

$ npm install tiptap-math

This extension requires the katex library, so you need to install it as well:

npm install katex

Usage

Make sure to import the KaTeX styles into your document.

import "katex/dist/katex.min.css";
import { useEditor, EditorContent } from "@tiptap/react";
import StarterKit from "@tiptap/starter-kit";
import Mathematics from "tiptap-math";

const extensions = [
  StarterKit,
  Mathematics,
];

const Tiptap = () => {
  const editor = useEditor({
    extensions,
  });

  return <EditorContent editor={editor} />
};

export default Tiptap;

Styling

The following classes are applied to the math node:

/* The container of the math block node */
.math {
    //...
}

/* This class is applied to the parent when the math node is selected (i.e. the cursor is inside the math node) */
.math-selected {
    //...
}

/* The node that contains the LaTeX text */
.math-content {
    //...
}

/* This class is applied to the LaTeX text node when it does not have any content */
.math-content-empty {
    //...
}