jstransformer-marky-markdown

marky-markdown support for JSTransformers.

Installation

npm install jstransformer-marky-markdown

API

var md = require('jstransformer')(require('jstransformer-marky-markdown'));

md.render('# Hello World!').body;
//=> '<h1>Hello World!</h1>'

Plugins

Plugins in markdown-it (the underlying markdown renderer for marky-markdown) are applied with the .use function:

var md = require('markdown-it')();
md.use(require('plugin1'));
md.use(plugin2);
md.use(plugin3, opts, ...);
md.use(require('plugin4'), opts, ...);

jstransformer-marky-markdown allows doing the same through the plugins option:

var md = require('jstransformer')(require('jstransformer-marky-markdown'));

md.render(markdown, {
  plugins: [
    'plugin1',
    plugin2,
    [plugin3, opts, ...],
    ['plugin4', opts, ...]
  ]
}).body;

If an element of the plugins array is a string, it is required. If an element is an array, the first element will represent the plugin, while the rest are treated as options to that plugin.

Rules

markdown-it allows enabling and disabling specific rules through md.disable and .enable functions:

var md = require('markdown-it')();
md.disable([ 'link', 'image' ]);
md.disable('backticks');
md.disable('might-not-exist', true);
md.enable('might-not-exist2', true);

In jstransformer-marky-markdown, the same thing can be done with the enable and disable options, with slightly modified syntax:

var md = require('jstransformer')(require('jstransformer-marky-markdown'));

md.render(markdown, {
  disable: [
    'link',
    'image',
    'backticks',
    ['might-not-exist', true]
  ],
  enable: [
    ['might-not-exist2', true]
  ]
}).body;

License

MIT