1167270 - Have more favorable markdown header font styles

Status: RESOLVED FIXED

(Bugzilla :: Creating/Changing Bugs, enhancement)

Description

[Albert Ting]

Having used Markdown in production for a while, I find in most cases folks will inline code that looks like this

# comment 1
# comment 2
code....

However, Markdown treats them as H1 headers.  While I can train folks to wrap code with ``` or indent, it doesn't scale, somebody will forget.  

For now, I'm overriding _DoHeaders to treat the above as italicized comments.

Comment 1

[Frédéric Buclin]

I think it doesn't make sense to override what # means in markdown. The official documentation says that # is used for headers http://daringfireball.net/projects/markdown/syntax#header

If you don't like the Markdown syntax, then don't use it. But someone used to the Markdown syntax would suddenly be surprised that Bugzilla uses # differently. IMO, this bug is WONTFIX.

Comment 2

[Albert Ting]

It is more dealing with accidental markdown-based comments.  Trying to encourage folks to use the feature, yet due to the number of unintended headers, people are choosing to turn off markdown.  That sort of defeats the benefits of Markdown in the first place.

For now, I'm using a mix of smaller header font sizes and treat the original multi-line example as a code block.

Comment 3

[Albert Ting]

Having used Markdown for about a year, I think defining more reasonable font size is more than sufficient. Or at least define smaller fonts in html-based emails, as H1 text on an iPhone is unnecessarily large.  Currently using 1.3em, 1.2em, and 1.1em for H1/H2/H3.

Comment 4

[Dylan Hardison [:dylan] (he/him)]

Albert -- can you supply the style(s) you're using?

:f1ish, make sure to incorporate these into the new skin (=sandstone). We'll get them into the legacy one as well.

Comment 5

[Albert Ting]

I kept it simple and just tweaked the font sizes, added this to both bug.css as well as bugmail.html.tmpl. 

 .bz_comment_text h1 {
   font-size: 1.3em;
 }

 .bz_comment_text h2 {
   font-size: 1.2em;
 }

 .bz_comment_text h3 {
   font-size: 1.1em;
 }

Comment 6

[u430950]

I'll write a new patch for bug 988971 factoring these changes in.

Comment 7

[Albert Ting]

When folding into Sandstone/Modal, perhaps some background coloring for H1/H2?

Comment 8

[Kohei Yoshino [:kohei]]

Has been solved in Bug 1518268.