Package Exports

tiptap-markdown

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tiptap-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Tiptap markdown

Edit markdown content in tiptap editor.

Installation

npm install tiptap-markdown

Requirements

This package only works with tiptap v2, tiptap v1 is not supported.

Usage

Vue 3 example:

import { Editor } from "@tiptap/vue-3";
import StarterKit from '@tiptap/starter-kit';
import { createMarkdownEditor } from "tiptap-markdown";

const MarkdownEditor = createMarkdownEditor(Editor);

export default {
    // ...
    mounted() {
        this.editor = new MarkdownEditor({
            content: "# Title",
            extensions: [
                StarterKit,
            ],
        });
        const markdownOutput = this.editor.getMarkdown();
    }
}

API

soon

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.