markdown-it-synapse-heading

tag for markdown-it markdown parser.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-it-synapse-heading
101.0.17 years ago7 years agoMinified + gzip package size for markdown-it-synapse-heading in KB

Readme

markdown-it-synapse-heading
Build Status NPM version Coverage Status
Heading plugin for markdown-it markdown parser that supports Synapse requirements. More specifically, in a SPA where the html page fragment identifier has been hijacked for GWT places/activities, our Table Of Contents widget must rely on js to jump to Headings discovered in the html output. Note that the standard heading module must not be enabled (in your markdown-it setup) in order for this module to handle headings!
v1.+ requires markdown-it v5.+, see changelog.
# Heading 1 => <h1 toc="true">Heading 1</h1>
#Heading 1 => <h1 toc="true">Heading 1</h1>

toc attribute not added if #'s are followed by '!'

#! Heading 1 => <h1>Heading 1</h1>

Install

node.js, browser:
npm install markdown-it-synapse-heading --save
bower install markdown-it-synapse-heading --save

Use

var md = require('markdown-it')()
            .use(require('markdown-it-synapse-heading'));

md.render('# Heading 1') // => '<h1 toc="true">Heading 1</h1>'

The widgetparams can be used to determine what kind of html widget should be rendered in the output container.
Differences in browser. If you load script directly into the page, without package system, module will add itself globally as window.markdownitSynapseHeading.

License

MIT