Example: mark-rule

<script setup lang="ts">
import 'prosekit/basic/style.css'
import 'prosekit/basic/typography.css'

import { createEditor } from 'prosekit/core'
import { ProseKit } from 'prosekit/vue'
import {
  ref,
  watchPostEffect,
} from 'vue'

import { defineExtension } from './extension'

const editor = createEditor({ extension: defineExtension() })
const editorRef = ref<HTMLDivElement | null>(null)
watchPostEffect((onCleanup) => {
  editor.mount(editorRef.value)
  onCleanup(() => editor.unmount())
})
</script>

<template>
  <ProseKit :editor="editor">
    <div class='box-border h-full w-full min-h-36 overflow-y-hidden overflow-x-hidden rounded-md border border-solid border-gray-200 dark:border-gray-700 shadow flex flex-col bg-white dark:bg-gray-950 color-black dark:color-white'>
      <div class='relative w-full flex-1 box-border overflow-y-scroll'>
        <div ref="editorRef" class='ProseMirror box-border min-h-full px-[max(4rem,_calc(50%-20rem))] py-8 outline-none outline-0 [&_span[data-mention="user"]]:text-blue-500 [&_span[data-mention="tag"]]:text-violet-500' />
      </div>
    </div>
  </ProseKit>
</template>

import {
  defineBaseCommands,
  defineBaseKeymap,
  defineDoc,
  defineHistory,
  defineParagraph,
  defineText,
  union,
} from 'prosekit/core'
import {
  defineLinkMarkRule,
  defineLinkSpec,
} from 'prosekit/extensions/link'
import { definePlaceholder } from 'prosekit/extensions/placeholder'
import { defineVirtualSelection } from 'prosekit/extensions/virtual-selection'

import { defineIssueLink } from './issue-link'

export function defineExtension() {
  return union(
    defineDoc(),
    defineText(),
    defineParagraph(),
    defineHistory(),
    defineBaseKeymap(),
    defineBaseCommands(),
    defineVirtualSelection(),
    defineLinkSpec(),
    defineLinkMarkRule(),
    definePlaceholder({ placeholder: 'Try typing #123' }),
    defineIssueLink(),
  )
}

export type EditorExtension = ReturnType<typeof defineExtension>

import {
  defineMarkSpec,
  union,
} from 'prosekit/core'
import { defineMarkRule } from 'prosekit/extensions/mark-rule'

export function defineIssueLink() {
  return union(
    defineMarkSpec({
      name: 'issueLink',
      inclusive: false,
      attrs: {
        issueNumber: {},
      },
      toDOM(node) {
        const issueNumber = node.attrs.issueNumber as number
        return [
          'a',
          {
            href: `https://example.com/issues/${issueNumber}`,
            title: `Issue #${issueNumber}`,
          },
          0,
        ]
      },
    }),
    defineMarkRule({
      regex: /#(\d+)/g,
      type: 'issueLink',
      attrs: (match) => {
        return { issueNumber: Number.parseInt(match[1]) }
      },
    }),
  )
}