Which Stack-Overflow style Markdown (WMD) JavaScript editor should we use? [closed]

Question

Background

I'm working on an application which requires user-entered content, and I've decided to use a Stack Overflow-style Markdown editor. After researching this topic for the last few days, I realize there are numerous forks of the base WMD editor, some with a few basic enhancements and some with serious differences from the Stack Overflow one.

Since this will be the heart of the application, I'd like to start with the best code base I can. I'd be happy if anyone can recommend which one of the many solutions out there best fits my needs.

Below are requirements, plus what I've managed to find already. I'm hoping this question will help me decide which version to go with, and maybe help me discover a port that's an even better fit for my needs.

---

The requirements for my project

• Live preview
• Multiple editors on the same page (I do not know how many in advance, since the user can dynamically add another editing box).
• Ability to extend with extra buttons (I'd like a button to upload a picture, instead of just adding an img URL).
• Ability to dynamically show/hide the edit box (and only see the preview box).
• Not an absolute must, but I'd prefer to stick as close to Stack Overflow's look and feel, since it's well known.
• Don't know if this matters, but the backend is written in Django.

Editors I've looked at

Here are a few of the code bases I've looked at, with thoughts. Obviously, I might be missing another solution out there.

• The derobins version. From what I can tell, this is the official Stack Overflow version. Seems like it doesn't support multiple editors on one page.
• jQuery.MarkEdit. Looks very good, but is pretty different from the Stack Overflow version.
• MooWMD. Looks like the winner right now, but I'm a little concerned since it looks less active/hackable than MarkEdit.
• The wmd-new version. Not sure, looks like an old codebase without much use.
• The SocialSite branch. Seems like it's not for public use.

Duffy

Good question. I'm investigating this issue myself, and I've so far worked out that the auto-indenting of lists is broken in Chrome in the derobins version and others. The SO version appears to have this auto-indenting turned off anyway, although I'm not sure what's been changed to do this (the doList is still there). – Tetrasyllable

I believe I ran into an open sources release of the genuine artifact. Can't find the darn thing again. – Doti

Answer 1

In the end, after looking around a bit more for a ready-made editor, I settled on the OpenLibrary WMD port, located at http://github.com/openlibrary/wmd.

The reasons I chose this editor

1. Meets most of my requirements.
2. Looks like Stack Overflow's editor. There are a few behavioral differences (see below).
3. Is built on top of jQuery (and doesn't require MooTools, which is a plus over the other serious contender, mooWMD).

I ended up implementing the functionality which shows/hides the editbox myself, which proved pretty easy for the most part. I haven't extended the editor with any buttons, which I'm sure will require some messing around in its source, but I don't think it will be too big a deal.

Differences from the Stack Overflow version

There are a few differences from the Stack Overflow editor:

1. Single enters at the end of lines cause a <br/>, instead of being considered one paragraph. I happen to prefer it this way, so I'm fine with this change.
2. Numbered lists are auto-numbered, ala Microsoft Word. That is, hitting Enter after writing "1. first item" will automatically get you a line that starts with "2. ". This is also a change I really like.

Well, I hope this helps anyone looking for a similar editor. If I end up customizing the editor, I'll create my own branch (it's licensed under the MIT license), but right now I'm getting away without tinkering with the source code.

Duffy

Hi, I just downloaded openlibrary/wmd, but it does not seem to work, there are problems with the jquery.wmd.min.js – Banana

Answer 2

Well, this question (and solutions) are getting pretty old, so I thought maybe I'd put something up to date here. :)

It's the beginning of 2014, and when I reached the same problem I eventually used PageDown-Bootstrap. It's a Twitter Bootstrap-based WMD editor, with fully customizable Style Bar (Button Bar).

There's also an alternative called Bootstrap-Markdown, which also looks very promising.

Stroganoff

Answer 3

For the live preview part, the Showdown library is pretty easy to work with (and as Edan points out, is included in the codebase)

You use it something like this (don't need to use jQuery if you don't want to)

$(document).ready(function(){
    var converter = new Attacklab.showdown.converter();
    function update_description_preview(){
        $('#description-preview').html(converter.makeHtml($("#id_description").val()));
    }
    update_description_preview();

    $("#id_description").keyup(function(){
        update_description_preview();
    });
});

The update_description_preview function uses the converter object to read the markdown in the #id_description element, and dumps it into the #description-preview element.

Here I am calling the function right after it is defined to initialize the preview windows (there was some text pre-loaded in the editor)

Last bit is just registering the function with the keyup event.

Portsmouth

Doesn't WMD (at least the StackOverflow version) use Showdown.js to do the conversion? At least, that's what I understood at one point. – Duffy

Doh. Forgot that showdown was included in the codebase. My last project was live preview only (Markdown syntax entered by hand, no JS editor), so I needed to use showdown seperately. – Portsmouth

Answer 4

Not sure if it fully fits to the old requirements, but another solution available in 2014 is the Open Source Markdown editor with preview licensed under Apache 2.0 and created by topten software.

Online demo is available here: http://www.toptensoftware.com/markdowndeep/dingus

Dustup

Answer 5

Standard Common Markdown includes a standalone javascript file to convert markdown to html. It is easy to implement as shown in the official demo or this plunker.

Roughly:

<script src="//jgm.github.io/stmd/js/stmd.js"></script>
...
var reader = new stmd.DocParser();
var writer = new stmd.HtmlRenderer();
...
var parsed = reader.parse("Some **markdown** text");
var result = writer.renderBlock(parsed);

Festinate