Hashtags in the beginning are rendered as headings

[jorilallo]

I ran into a problem while testing hashtags:

marked("#hashtag test\n test")

renders as

<h1>hashtag test</h1>
<p> test</p>

while the expected output is

<p>#hashtag test</p>
<p> test</p>

[Mithgol]

That's the expected behaviour, because the # character marks a heading.

Work around by using \# instead of a simple #.

Also note that a single \n won't get you a new paragraph. Use two \n for that.

[jorilallo]

@Mithgol according to Markdown documentation there needs to be a space character after the #, not combined. Also GitHub doesn't render that as a heading.

Edit: for the example I was using GFM's newline support so it renders to paragraphs

[jorilallo]

So I think the correct regular expression should be

heading: /^ *(#{1,6}) +([^\n]+?) *#* *(?:\n+|$)/,

Here's an example render with GitHub's Markdown. Source:

#header
# header1
#  header1

Result:

#header

header1

header1

[Mithgol]

Good argument. I am convinced.

[tarqd]

I'd like to see this merged, +1

[chjj]

$ echo '#foo' | markdown.pl
<h1>foo</h1>

Not sure this qualifies as a fix. It violates markdown.pl behavior.

[tarqd]

Ah well if markdown.pl behaves that way I'd just leave it. You can always escape it anyway

[jorilallo]

@chjj @ilsken Just for the sake of arguments, has anyone ever really used markdown.pl? I would stick with the documentation (which states "# heading") and common sense but that's just me. Having #hashtags and @mentions is pretty common with services.

[Mithgol]

Being backwards compatible with markdown.pl is important.

However, it seems like the GFM mode could imitate GitHub flavoured Markdown better if it took the whitespace in consideration after the # character.

[jorilallo]

+1 for GFM

Jori Lallo

+1 (415) 728 5773
@jorilallo (http://twitter.com/jorilallo)

http://kippt.com

On Friday, August 2, 2013 at 12:05 PM, Mithgol wrote:

Being backwards compatible with markdown.pl (http://markdown.pl) is important.
However, it seems like the GFM mode could imitate GitHub flavoured Markdown better if it took the whitespace in consideration after the # character.

—
Reply to this email directly or view it on GitHub (#201 (comment)).

[elennaro]

+1 for GFM
Having hashtags is good!
Also if GFM does this way when I enable GFM I expect same behaviour.
At least can anyone give me a hint: how to apply it 4 my needs easily, please?

[Mithgol]

@elennaro It's as easy as manually applying the patch jorilallo/marked@09c26a8. It replaces only one character in the source code (* → +) and thus it couldn't be any easier.

[elennaro]

Oh, thank you @Mithgol really simple and beautifull!

[ledsun]

+1 for GFM

[silkimen]

+1 GFM

[chjj]

Fixed.

[xaka]

I know it's been a while, but for the future reference I want to point out that this change should have never landed as a patch (0.3.2 -> 0.3.3), but at least as a minor (0.3.2 -> 0.4.0) because it's backward incompatible from customer's perspective, who don't care about whitespace because it's been allowed for a long time and now it breaks existing badly formatted markdowns. No complains whatsoever. Just suggestions 😉

[Stephen-Mc]

Very unhappy at this change, it broke all our documentation by no longer rendering the headings correctly. Would love to see it reverted, as breaking existing docs just to be able to render hashtags without an escape character does not strike me as the right set of priorities.

Thankfully most of our docs are parsed for conversion to HTML, and are still rendered correctly on our websites, but I have 100 or so pages that are not parsed this way and now need to be updated with the new heading style.

[zcyzcy88]

How about <h1> require space, and <h2>~<h6> don't require space?
When they type # without space, it often means hashtag, not <h1>.

---

Example:

Text Text Text Text Text Text Text Text.
#tag1 #tag2

Now render as:

Text Text Text Text Text Text Text Text.

tag1 #tag2

Expect:

Text Text Text Text Text Text Text Text.
#tag1 #tag2

[Stephen-Mc]

That would be even more confusing than the current state of affairs.

[Grey2k]

#hashtag# test