Tiptap 中文文档

Markdown 扩展 API

Beta

扩展配置

Markdown.configure(options)

使用自定义选项配置 Markdown 扩展。

Markdown.configure({
  indentation?: {
    style?: 'space' | 'tab'
    size?: number
  },
  marked?: typeof marked,
  markedOptions?: MarkedOptions,
})

参数

  • indentation（可选）

    • style：缩进字符：'space'（空格）或 'tab'（制表符）。默认：'space'
    • size：缩进字符数量。默认：2

  • marked（可选）

    • 用于解析的自定义 MarkedJS 实例

  • markedOptions（可选）

    • 传递给 marked.setOptions() 的配置项
    • 详情参见 marked 文档

示例 

import { Markdown } from '@tiptap/markdown'

const markdown = Markdown.configure({
  indentation: {
    style: 'space',
    size: 4,
  },
  markedOptions: {
    gfm: true,
    breaks: false,
  },
})
PreviouslyMarkdownManager