Why "id" attribute is being generated on heading elements?

[smohadjer]

I see that this line of markdown:

This is a test of GFM for javascript

once converted to HTML becomes this:

<h1 id="this-is-a-test-of-gfm-for-javascript">This is a test of GFM for javascript</h1>

Which option is responsible for auto-generating id in heading elements and how can this be turned off?

[treasonx]

I thought this was standard markdown. https://github.com/gitlabhq/gitlabhq/blob/master/doc/markdown/markdown.md#headers

[treasonx]

I did a little more digging. I was always under the assumption this was standard markdown behavior. Grunt markdown uses https://github.com/chjj/marked It might be part of the GFM option. You can pass options to marked using the markdownOptions of in your grunt file

[smohadjer]

I don't see any option for disabling auto generation of id attributes on headings, do you?

[treasonx]

No I don't you might not be able to disabled it.

https://github.com/chjj/marked/blob/master/lib/marked.js#L788

Thats where they are adding the ID. I don't seen any obvious way of disabling that behavior.

[smohadjer]

I don't think this is part of standard markdown. John Gruber's markdown samples and his Dingus app do not generate such id on headings when converting markdown to html, nor does Github.

http://daringfireball.net/projects/markdown/dingus

[treasonx]

Yea not sure where this came from. Marked is doing it and since i am using marked there is little I can do about it.

Looks like there is some discussion on this thread markedjs/marked#515

[smohadjer]

Others have also complained about this:
markedjs/marked#420

Marked's development seems to be stalled with 180 open issues.

[smohadjer]

Have you looked into this? https://github.com/evilstreak/markdown-js

[treasonx]

Does it support GFM? GFM is really important for a lot of the common uses of grunt markdown.

[smohadjer]

Not yet, but he is working on it. You can voice your support for it here:
evilstreak/markdown-js#41

[treasonx]

If you really want to remove the ids you could do it in postCompile. I think thats all I can do for right now since marked doesn't expose a setting.

[smohadjer]

I think I can live with it. Thanks for your help.

[dnutels]

Wouldn't you be able to override marked's Renderer and override it's heading handler?

[treasonx]

@dnutels yes I could but right now I don't extend marked at all. If I start to extend marked the plugin will become coupled to marked. I like to keep the coupling loose so if I find a better markdown parser I should be able to swap it easily.

[dnutels]

1. at some point one has to give up :) and admit that marked is the de-facto standard
2. you can abstract that setting - since any "better" markdown plugin should have the ability to alter the way headings are generated (otherwise you'd be trading down, IMO):

{
    ...
    markdown: {
        heading: function() {...}
    }
}

[sulhome]

it looks like id is being added to headings only. Use a renderer to override this as follow:

var marked = require('marked');
var renderer = new marked.Renderer();
renderer.heading = function (text, level) { 
  return `<h${level}>${text}</h${level}>`;
};