# tiptap-markdown

> Edit markdown content in tiptap editor.

Latest version **0.9.0** (published 2025-09-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install tiptap-markdown
pnpm add tiptap-markdown
yarn add tiptap-markdown
bun add tiptap-markdown
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2025-09-08 |
| First published | 2021-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 231.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 524 |
| Author | Antoine Guingand |
| Maintainers | aguingand |

## Links

- npm: https://www.npmjs.com/package/tiptap-markdown
- Repository: https://github.com/aguingand/tiptap-markdown
- Homepage: https://github.com/aguingand/tiptap-markdown#readme
- Issues: https://github.com/aguingand/tiptap-markdown/issues
- npm.io page: https://npm.io/package/tiptap-markdown

## Dependencies (4)

- [markdown-it](https://npm.io/package/markdown-it.md) ^14.1.0
- [@types/markdown-it](https://npm.io/package/@types/markdown-it.md) ^13.0.7
- [prosemirror-markdown](https://npm.io/package/prosemirror-markdown.md) ^1.11.1
- [markdown-it-task-lists](https://npm.io/package/markdown-it-task-lists.md) ^2.1.1

## Recent versions

- 0.9.0 (latest) — 2025-09-08
- 0.8.10 — 2024-03-21
- 0.8.9 — 2024-01-12
- 0.8.8 — 2023-12-03
- 0.8.7 — 2023-11-29
- 0.8.6 — 2023-11-29
- 0.8.5 — 2023-11-29
- 0.8.4 — 2023-11-06
- 0.8.3 — 2023-11-01
- 0.8.2 — 2023-07-22
- 0.8.1 — 2023-06-25
- 0.8.0 — 2023-06-23
- 0.7.4 — 2023-06-08
- 0.7.3 — 2023-06-06
- 0.7.2 — 2023-05-18
- … 18 more at https://npm.io/package/tiptap-markdown/versions

## README

> [!WARNING]
As Tiptap have now a solution for markdown (paid [Conversion extension](https://next.tiptap.dev/docs/conversion/import-export/markdown/editor-extensions) and more markdown handling [announced for v3](https://next.tiptap.dev/docs/resources/whats-new#whats-next-in-tiptap-3x)). I don't plan to release [v1](https://github.com/aguingand/tiptap-markdown/pull/67) nor addressing current issues / PR. Feel free to fork the project if you need.

# Tiptap markdown

The markdown extension for [Tiptap editor](https://www.tiptap.dev/).

## Installation

For Tiptap v2

```bash
npm install tiptap-markdown@^0.8
```

For Tiptap v3

```bash
npm install tiptap-markdown@latest
```


### Requirements
Supports all frameworks handled by Tiptap (Vue 2, Vue 3, React, [see full list](https://www.tiptap.dev/installation#integration-guides)...)

## Usage
Basic example:

```js
import { Editor } from '@tiptap/core';
import StarterKit from '@tiptap/starter-kit';
import { Markdown } from 'tiptap-markdown';

const editor = new Editor({
    content: "# Title",
    extensions: [
        StarterKit,
        Markdown,
    ],
});
const markdownOutput = editor.storage.markdown.getMarkdown();
```

## API

### Options
Default options:
```js
Markdown.configure({
  html: true,                  // Allow HTML input/output
  tightLists: true,            // No <p> inside <li> in markdown output
  tightListClass: 'tight',     // Add class to <ul> allowing you to remove <p> margins when tight
  bulletListMarker: '-',       // <li> prefix in markdown output
  linkify: false,              // Create links from "https://..." text
  breaks: false,               // New lines (\n) in markdown input are converted to <br>
  transformPastedText: false,  // Allow to paste markdown text in the editor
  transformCopiedText: false,  // Copied text is transformed to markdown
})
```

### Methods
```js
editor.commands.setContent('**test**') // setContent supports markdown format
editor.storage.markdown.getMarkdown(); // get current content as markdown
```

### Custom extensions
See [examples](https://github.com/aguingand/tiptap-markdown/tree/main/example/src/extensions).  
Check out prosemirror-markdown [default serializer](https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L66) for examples of serialize config. Check out markdown-it [plugins](https://github.com/markdown-it/markdown-it#syntax-extensions) for parsing.

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.

---
_Source: https://npm.io/package/tiptap-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._