Markdown Extension API

Beta

Extension Configuration

Markdown.configure(options)

Configure the Markdown extension with custom options.

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

Parameters

  • indentation (optional)

    • style: Indentation character: 'space' or 'tab'. Default: 'space'
    • size: Number of indentation characters. Default: 2
  • marked (optional)

    • Custom MarkedJS instance to use for parsing
  • markedOptions (optional)

Example

import { Markdown } from '@tiptap/markdown'  const markdown = Markdown.configure({  indentation: {  style: 'space',  size: 4,  },  markedOptions: {  gfm: true,  breaks: false,  }, })