@tiptap/pm

Schema Creation

This feature allows you to define the structure of your document. The schema defines the nodes and marks that can be used in the editor.

const { Schema } = require('@tiptap/pm');

const mySchema = new Schema({
  nodes: {
    doc: { content: 'block+' },
    paragraph: { content: 'text*', toDOM: () => ['p', 0], parseDOM: [{ tag: 'p' }] },
    text: { inline: true }
  },
  marks: {}
});

Commands

Commands are functions that perform actions on the editor state. This example shows how to create a command to toggle a bold mark.

const { toggleMark } = require('@tiptap/pm');

const boldCommand = toggleMark(mySchema.marks.bold);

// Usage in an editor instance
editor.commands.bold = () => boldCommand(editor.state, editor.dispatch);

Input Rules

Input rules are used to automatically transform text as the user types. This example shows how to create an input rule that transforms text starting with '>' into a blockquote.

const { inputRules, wrappingInputRule } = require('@tiptap/pm');

const blockquoteRule = wrappingInputRule(/^
*>
$/, mySchema.nodes.blockquote);

const myInputRules = inputRules({ rules: [blockquoteRule] });