metalsmith-showdown

A Metalsmith plugin for converting markdown using the showdown library.

Installation

npm install metalsmith-showdown

Usage

var metalsmith = require('metalsmith');
var showdown = require('showdown');

metalsmith
    .use(showdown({
      //options
    ))

Options

convert

(default ["contents"])

An array of post properties to convert (e.g. convert: ["excerpt", "contents"])

options

(optional, object)

Pass options to showdown.

Example

.use(showdown({
  convert : ["excerpt", "contents"],
  options: {
    strikethrough: true,
    tables: true,
    tasklists: true,
  },
}))

Inline Use

You can access showdown directly by using showdown.expose. For example to create a new converter:

var metalsmith = require('metalsmith');
var showdown = require('showdown');
var md = new showdown.expose.Converter({/*options*/})

//then later
var str = md.makeHtml(str)