1476107 - Implement new Markdown editor widget with text formatting toolbar and keyboard shortcuts

Status: NEW

(bugzilla.mozilla.org :: Bug Creation/Editing, enhancement)

Description

[Kohei Yoshino [:kohei]]

Once the Markdown support is landed, the comment field should offer a text formatting toolbar as seen on GitHub and BzDeck, which allows users to format their comment without knowing the Markdown syntax.

https://help.github.com/articles/about-writing-and-formatting-on-github/
https://twitter.com/BzDeck/status/728299177986408448

Maybe the relevant BzDeck code can be ported for a quick implementation:

https://github.com/bzdeck/bzdeck/issues/370

Comment 1

[Mats Palmgren (inactive)]

I agree. This should be considered a bug, not an "enhancement".

I am particularly worried about bug comments from less experienced
contributors / users who very often include HTML markup snippets
in comments given the nature of our work...

Comment 2

[Kohei Yoshino [:kohei]]

We currently have 3 different comment box assets with Markdown preview:

• modal bug page
• legacy bug page, new/edit attachment page & enter bug page
• edit comment extension (Bug 1518328)

More to come…

• user story extension (Bug 1518755)
• admin-editable fields, e.g. component description

Given the new formatting toolbar, we need a shared Markdown editor+preview widget that can be inserted to anywhere.

Comment 4

[Kohei Yoshino [:kohei]]

I personally want Cmd+K to insert a link, so will work on this now…

Comment 5

[Kohei Yoshino [:kohei]]

Attachment: GitHub Pull Request

Here. We. Go.

Comment 7

[Master ? [:masterquestionable]]

    [ Quote Brian Hackett @ CE 2019-01-27 02:07 UTC:
https://bugzilla.mozilla.org/show_bug.cgi?id=1523137#c0
    Would it be possible ... to either not use markdown, or have an easy way to disable markdown when commenting? (I don't see anything in the comment UI or in my user preferences to avoid using markdown.) ]

    [ Quote Kohei Yoshino @ CE 2019-07-11 02:12 UTC:
https://bugzilla.mozilla.org/show_bug.cgi?id=1523137#c1
    Bug 1476107 allows to disable Markdown in the comment editor. ]

    This element seems more important to me.
    .
    Related: https://github.com/github-community/community/discussions/16929#discussioncomment-3151079