Tiptap markdown

The markdown extension for Tiptap editor.

> Warning
> Since v0.7.0, createMarkdownEditor has been dropped in favor of a more friendly Markdown Tiptap extension. See the migration guide.

Installation

``bash
npm install tiptap-markdown
`

$3

Supports all frameworks handled by Tiptap (Vue 2, Vue 3, React, see full list...)

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

$3


Default options:
`js
Markdown.configure({
html: true, // Allow HTML input/output
tightLists: true, // No

inside

in markdown output
tightListClass: 'tight', // Add class to

allowing you to remove

margins when tight
bulletListMarker: '-', //

• prefix in markdown output
linkify: false, // Create links from "https://..." text
breaks: false, // New lines (\n) in markdown input are converted to

transformPastedText: false, // Allow to paste markdown text in the editor
transformCopiedText: false, // Copied text is transformed to markdown
})
`

  $3

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

  $3

  
  See examples.
  Check out prosemirror-markdown default serializer for examples of serialize config. Check out markdown-it plugins 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 for more information.