Implement linkable headers

[javigomez]

I just found this http://ben.balter.com/2014/03/13/pages-anchor-links/

@Hutchy68 do you think we can add it?

[Hutchy68]

Looks like a great addition, I'll look into it.

[javigomez]

I did a quick test but I think it conflicts with mootools. Didn't had time to check

[Hutchy68]

Darn Mootools!

[Hutchy68]

Hey, it looks like we can do it with marked.js.

https://github.com/chjj/marked#overriding-renderer-methods

here is the piece of code which builds the currentDoc or defaults to introduction, followed by the 3 lines which send everything out to show the menu, currentDoc, and version.

window.addEvent('domready', function() {
    var urlParts = document.URL.split('?', 2);
    state = {};
    here = urlParts[0];

    if (urlParts.length > 1)
    {
        var currentDoc = urlParts[1];
    }
    else
    {
        var currentDoc = "coding-standards/introduction.md";
    }

    marked.setOptions({
        gfm: true,
        pedantic: false,
        sanitize: false,
        highlight: function(code, lang) {
            var that;
            Rainbow.color(code, lang, function(hl_code) { that = hl_code; });
            return that;
        }
    })
    populateMenu();
    populateWindow(currentDoc);
    populateVersion();

Looks like this dictates the options of marked.js

marked.setOptions({
        gfm: true,
        pedantic: false,
        sanitize: false,
        highlight: function(code, lang) {
            var that;
            Rainbow.color(code, lang, function(hl_code) { that = hl_code; });
            return that;
        }
    })

The instructions aren't too clear on how to override the renderer.

[javigomez]

Neat! it even provides Github flavored markdown https://github.com/chjj/marked#gfm that is awesome for code hightlights

[javigomez]

Adding link for document the decisions: https://twitter.com/TomHutchisonJr/status/511215090335752193

[Hutchy68]

Just not if we should use eco or coffeeKup. I like CoffeeKup but the template engine is very picky. One mistake and it breaks until you fix it.