Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.56 KB

README.md

File metadata and controls

40 lines (24 loc) · 1.56 KB
Raw

markdown-it-synapse

Build Status NPM version Coverage Status

Synapse tag plugin for markdown-it markdown parser.

v1.+ requires markdown-it v4.+, see changelog.

${image?fileName=joy%2Epng&align=None} => <span id="widget-0my-unique-div-id" class="widgetContainer" widgetparams="image?fileName=joy%2Epng&amp;align=None" />

Install

node.js, browser:

npm install markdown-it-synapse --save
bower install markdown-it-synapse --save

Use

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

md.render('${image?fileName=joy%2Epng&align=None}', 'my-unique-div-id') // => '<span id="widget-0my-unique-div-id" class="widgetContainer" widgetparams="image?fileName=joy%2Epng&amp;align=None" />'

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.markdownitSynapse.

License

MIT