Is there a getting started guide?

1

I am trying to find a getting started guide so I can use ProseMirror in my MPlace2.social project. Found the responses to the other requests rather off-putting. I don’t think it insulting or rude to ask for basic information such as:

What language is this written in, what version, what dependencies does it rely on?

To give a bit of context here, I worked on HTTP/1.0 and HTML/2.0. I know about a vast number of Web technologies, trying to work out which one is being used is rather more difficult than you might expect.

All I am looking for is a widget that I can put into a Web page that will allow the user to enter a document with a minimal markup set (essentially HTML/2.0, headings paragraphs, lists, bullets), click a button and upload it to the server via HTTP POST.

The examples I see present a code example that doesn’t match any of the files used to present it. Took me quite a time to work out that example.js was what I was after.

I can see that there are two divs involved, one with the id ‘editor’ and the other with the id ‘content’. So, I am assuming that I can do some DOM scraping and extract the text in some sort of format. And that is what I will probably end up doing if I don’t get a reply. But I am pretty sure there is probably some function already defined that does exactly that.

More importantly, I am pretty sure that is what a very large number of users coming here also want.

A 'Hello World" example that demonstrates how to put together a minimal example would help a lot of people.

2

That is simply not what this library is. It does not provide a ready-to-use editor, it’s more of a low-level component for building one.

I know this isn’t the answer you’re looking for, but if you don’t already know how JavaScript package distribution works these days, or how to read a package.json file, you’re not going to have a good time with ProseMirror (or even any of the libraries that wrap it and provide a more drop-in experience, like Tiptap).

3

I’ve been working for a while on a package built with ProseMirror that might approach the problem from a perspective that is closer to what you’re looking for. It’s called the MarkupEditor. The web site should give you a decent overview and let you can see it in action. There is even a Hello World example :-). The Developer’s Guide is still a work in progress but is reasonably complete. I’d be very happy to receive any actionable feedback as issues.

1 Like
5

Unfortunately the author is right, you should first learn some basics, for today’s web. If you need a demo project, just check the prosemirror homepage, or just use vite and install the package, edit the html and run