prosekit/extensions/mark-rule

The options for defineMarkRule.

regex: RegExp

The regular expression to match against. It must has a g flag to match all instances of the mark.

type: string | MarkType

The mark type to apply to the matched text.

attrs?: Attrs | (match: RegExpMatchArray) => Attrs | null | null

Attributes to set on the mark. If a function is provided, it will be called with the matched result from the regular expression.

Default

Section titled “Default”

null

function defineMarkRule(options: MarkRuleOptions): PlainExtension

A mark rule is something that can automatically apply marks to text if it matches a certain pattern, and remove them if it doesn't match anymore.