---
title: "Markdown Extension API"
description: "Learn how to create custom Markdown extensions for Tiptap using the Markdown Extension API."
canonical_url: "https://tiptap.dev/docs/editor/markdown/api/extension"
---

# Markdown Extension API

Learn how to create custom Markdown extensions for Tiptap using the Markdown Extension API.

## Extension Configuration

### `Markdown.configure(options)`

Configure the Markdown extension with custom options.

```typescript
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)
  - Options passed to `marked.setOptions()`
  - See [marked documentation](https://marked.js.org/using_advanced#options)

#### Example

```typescript
import { Markdown } from '@tiptap/markdown'

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