Can't figure out how to stream markdown into tiptap

[fgatti675]

Hi everyone,
I am having a hard time figuring out how to stream markdown generated from an LLM into tiptap.
If I insert content as it comes, it fails in many ways. If I wait til the result is complete and just insert the full string, it works perfectly.
I have been trying a middle ground, spliting the markdown by lines, so I make sure format like bold are handled correctly.

This code simulates the calls that my code makes while streaming:

editor.chain().focus()
    .insertContent("- **Autosave**: Never worry about losing your work… are saved as you type, giving you peace of mind.\n")
    .run()
editor.chain().focus()
    .insertContent("- **Another line**: Never worry about losing your work… are saved as you type, giving you peace of mind.\n")
    .run();

And how it looks like:

I am using the markdown extension configured like:

export const markdownExtension = Markdown.configure({
    html: true,
});

It generates the new bulletlist node under the last one, no matter what I do, calling .enter() does nothing apparently, though I was expecting to jump to a new line

Any help is greatly appreciated!

[nperez0111]

It is very difficult to get streaming of formatted content into the editor it took me two weeks to get everything right for the content Ai pro extension. I would not say that there is an easy answer to this at all. I would recommend streaming into a preview element instead and only inserting the content into the editor afterwards.

[fgatti675]

Thank you. Yes I realised it is pretty complicated.
I will try your approach, I am going to stream HTML instead of markdown, directly into a decorator, and replace with the final content when complete. Does that make sense?
Thanks for your help!

[nperez0111]

Yea into a decoration sounds like a good plan

[fgatti675]

I could manage with your help, thanks a lot!!

Area.mp4

[anasmir-cm]

hey @fgatti675 can you share your solution for this?

[whisper-bye]

@fgatti675 would you please share your solution? thx a lot!

[gjc14]

Hi maybe this will be helpful. I made a component based on https://tiptap.dev/docs/editor/extensions/custom-extensions/node-views/react to handle api call and stream render.

gjc14/tiptap-streaming-preview

[whisper-bye]

@gjc14 amazing!!!

[eRuaro]

if the LLM is returning markdown content, you can use a markdown to html converter and pass the results to setContent:

import React, { useState, useEffect } from 'react';
import { useEditor, EditorContent } from '@tiptap/react';
import StarterKit from '@tiptap/starter-kit';
import Markdown from '@tiptap/extension-markdown';
import Link from '@tiptap/extension-link';
import { marked } from 'marked';

const MarkdownEditor = () => {
 const [answer, setAnswer] = useState([]);
 const [streaming, setStreaming] = useState(false);

  ... code that handles llm streaming, presumably this appends to the answer array

 const markdownToHtml = (markdown) => {
   return marked(markdown, {
     breaks: true,    // Convert \n to <br>
     gfm: true,       // Enable GitHub Flavored Markdown
     async: false
   });
 };

 const answerEditor = useEditor({
   editable: false,
   extensions: [
     StarterKit,
     Markdown,
     Link.configure({
       autolink: false,
     })
   ],
 });

 useEffect(() => {
   const content = answer.join("");
   const htmlContent = markdownToHtml(content);
   answerEditor?.commands.setContent(htmlContent);
 }, [answer, answerEditor]);

 return (
   <>
     {streaming && (
       <div className="border border-gray-600 shadow-md rounded-lg px-4 py-1 flex flex-col">
         <EditorContent 
           editor={answerEditor} 
           className="prose prose-p:text-md max-w-none whitespace-pre-wrap flex-grow" 
         />
       </div>
     )}
   </>
 );
};

export default MarkdownEditor; 

[luckymore]

Alas, it must be said that built-in features like platejs are actually charged in tiptap...

[bdbch]

What exact feature do you mean? The conversion service (server-side) or the client-side implementation Tiptap now supports via it's @tiptap/markdown package?

[bdbch]

Coming in with a new answer for everyone who looks for Markdown Support in Tiptap. Markdown is officially supported via an extra open source package @tiptap/markdown. Read more here.

[oskarscholander]

I did a repro now. Actually now when I see it standalone like this it really feels like I am allllmost there:
https://codesandbox.io/p/sandbox/tiptap-suggestions-pn9l7d

Kinda cool right? Since I do not know how to make it work with editor.commands I use https://www.npmjs.com/package/marked to convert markdown to HTML. I have yet to sanitize it. Only issue I have is that it doesn't convert to HTML when I apply. Do you have any suggestions to this?

[bdbch]

You would need to run insertContentAt() with { contentType: 'markdown' } there.

[bdbch]

Here's a fork:
https://codesandbox.io/p/sandbox/tiptap-suggestions-forked-qv8k97

[oskarscholander]

omg thank you so much!! I have been working on this all day even with a fever and had this thing that I was worried about that it might not will be working at all, and here you come and put the last cheddar on it! This made my day! Thanks buddy!

I didn't realize that I have access to chain! Of course!

[bdbch]

No worries, good luck with your project!