marked-sections

Section wrapping for markdown parsing

marked-sections

A simple node.js package to use marked to parse markdown and insert <section> tags around heading levels.

var mdsec = require('marked-sections');
 
mdsec.setOptions({
    levels: 2,
    heirarchy: false,
    // marked options too 
    gfm: true // see marked for full docs 
});
 
html = mdsec.parse(markdownText);
 
// Or you can do it manually 
tree = mdsec.marked.lexer(markdownText);
sectree = mdsec.insertSections(tree, { levels: 1 });
html = mdsec.marked.parser(sectree);

marked-sections takes two options above and beyond marked.

  • levels refers to the header levels to wrap in sections. It should be the highest header level that should be wrapped in a section.

  • heirarchy will make each level of header wrapped in a heirarchy of section tags. Defaults to false. For example:

    # H1
    something
    ## H2
    else
    # H1
    again

    becomes

    <section>
        <section>
            <h1>H1</h1>
            <p>something</p>
        </section>
        <section>
            <h2>H2</h2>
            <p>else</p>
        </section>
    </section>
    <section>
        <section>
            <h1>H1</h1>
            <p>again</p>
        </section>
    </section>

MIT Licensed 2013 Jon Eisen.