View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0017920 | mantisbt | markdown | public | 2014-11-25 11:46 | 2017-01-31 04:02 |
Reporter | vboctor | Assigned To | joel | ||
Priority | normal | Severity | feature | Reproducibility | N/A |
Status | closed | Resolution | fixed | ||
Product Version | 1.2.17 | ||||
Target Version | 2.1.0 | Fixed in Version | 2.1.0 | ||
Summary | 0017920: Native markdown support | ||||
Description | As per the majority of the development platforms having native support for markdown would be valuable. Examples of such environments include github and bitbucket. | ||||
Tags | No tags attached. | ||||
related to | 0004879 | new | Collapse/expand attached files section | |
related to | 0022180 | new | Markdown issues following implementation in 0017920 | |
related to | 0012744 | closed | dregad | WYSIWYG editor integration |
related to | 0012325 | new | Adding WYSIWYG editor to text areas | |
related to | 0010504 | closed | vboctor | New feature suggestion: Upload file in 'Add Note' ? |
related to | 0022122 | closed | atrol | Ability to format text and have bullets and numbered lists in text areas. |
related to | 0022189 | new | Provide Markdown syntax help |
See plugin at: I believe we need to think of this as an out of the box experience. |
|
Agreed. Plugging this in should be simple, but the migration path will be more complicated. |
|
Reminder sent to: atrol, dregad, rombert, syncguru Adding others to get feedback. I suggest that we start off with such support being controlled by a config option and then we can decide latest whether to make it the default. |
|
Agreed. This allows new installations to opt in to markdown and then we can think about migration. How about making markdown the default for new installations? |
|
I'm OK with the idea of offering MD out of the box, controlled by a config option that should IMO be defaulted to OFF (at least initially). We should offer a "preview" toggle in the affected text editing areas, along the lines of what Github does. Also, as mentioned by rombert, we need to be very careful about the migration path, and also consider what we're going to do with HTML codes (i.e. $g_html_valid_tags), links conversions, etc. I have never actually tried this plugin or even looked at its implementation, so no technical comments at this stage; we'd have to contact the author if we're going to bundle and/or adapt his work. |
|
In a first step we should choose a markdown parser and check
I searched a bit and found this one which seems to be a good candidate at first sight |
|
Another candidate library:
Related Links:
|
|
I don't think that a PHP library exists based on it yet, but for the record http://commonmark.org/ is an attempt to standardize and remove ambiguities in the original markdown spec (Github contributes to it, amongst others). WRT to cebe/markdown, it says PHP >= 5.4 while for 1.3 we currently target 5.3. |
|
Parsedown seems to target support for CommonMark spec, see the tests below: It also seems to win on PHP versions compatibility and github stars. I'll start experimenting with this one. License is MIT, so pretty good too. |
|
I commented on PR 930, but i think it's relevant enough to be copied here to share the point with team: Probably could be revisited later, but my ideal here is that Markdown is a plugin in itself, and is used or not, according to the formatting settings. Mantis core should pass text to the formatting plugin and it returns them as the processed output.
Maybe i misunderstood which were the assumed requeriments. In regards to integration method, that was not cleared in the related issue 17920. |
|
Markdown has become the defacto standard for formatting in the development community which is a majority of the user base of MantisBT. Hence, we want to provide this as a core plugin. I would start by recommending this as the markup format for new installations. Similar to other systems like github, bitbucket, jira, etc. We need to experiment with the experience of switching an existing instance from legacy formatting to markdown. In instances like others where we barely use html tags, it should be relative smooth transition. In some cases, existing text will look better, but in others lines may be combined in a single line due to markdown rules. We can in the future add some heuristics / compatibility mode or migration, but that is not going to be the target initially. Markdown will also be disabled by default to start with. |
|
I have learned to use markdown skills on stackoverflow website. It would be great if it could be implemented in MantisBT too. :) |
|
Original PR by @jllano https://github.com/mantisbt/mantisbt/pull/930 |
|
When can I try this out ? :) |
|
As of today right here in this bugtracker, or download the latest master branch nightly build. |
|
I can't see any markup labels indicating it is available???
This is a test This is a test |
|
I am confused. I see no markup output in this bugtracker???? |
|
Caused by a temporary problem. |
|
This looks better. :) Will we have some kind of little helper button with notes etc. about the markup syntax? |
|
@ajtruckle, I agree. I opened 22189 to track this |
|
Is this stable enough to try now in my own forum? |
|
I would definitely not call it stable, until we actually release it as part of the next version of MantisBT. As for installing it in your own instance, take a look at 0022180 for a list of known issues with this feature, and make up your own mind. You're anyway welcome to do it (at your own risk of course), and we would appreciate your testing and feedback. |
|
@ajtruckle this feature will be released with 2.1.0 planned for end of January. You should be able to use that. If you want sooner, you can use the nightly builds. |
|
How does the markdown format will affect the email notifications from Mantis? Will it continue with the existing text formatting? |
|
email notification is not affected (might happen in future versions) |
|
@vboctor is it still due for release at the end of this month? |
|
@ajtruckle I expect v2.1.0 to be out on 1/30. If not, then the weekend after. |
|