index.js

var cheerio = require('cheerio')
var defaults = require('lodash.defaults')
var render = require('./lib/render')
var sanitize = require('./lib/sanitize')
var badges = require('./lib/badges')
var cdn = require('./lib/cdn')
var github = require('./lib/github')
var youtube = require('./lib/youtube')
var gravatar = require('./lib/gravatar')
var packagize = require('./lib/packagize')

var marky = module.exports = function (markdown, options) {
  var html, $

  if (typeof markdown !== 'string') {
    throw Error('first argument must be a string')
  }

  options = options || {}
  defaults(options, {
    sanitize: true,
    linkify: true,
    highlightSyntax: true,
    prefixHeadingIds: true,
    serveImagesWithCDN: false,
    debug: false,
    package: null
  })

  var log = function (msg) {
    if (options.debug) {
      console.log('marky-markdown: ' + msg)
    }
  }

  log('\n\n' + markdown + '\n\n')

  log('Parse markdown into HTML and add syntax highlighting')
  html = render(markdown, options)

  if (options.sanitize) {
    log('Sanitize malicious or malformed HTML')
    html = sanitize(html)
  }

  log('Parse HTML into a cheerio DOM object')
  $ = cheerio.load(html)

  log('Make gravatar image URLs secure')
  $ = gravatar($)

  log('Resolve relative GitHub link hrefs')
  $ = github($, options.package)

  log('Dress up Youtube iframes')
  $ = youtube($)

  log('Add CSS classes to paragraphs containing badges')
  $ = badges($)

  log('Apply CSS classes to readme content already expressed by package metadata')
  $ = packagize($, options.package)
  if (options.serveImagesWithCDN) {
    log('Rewrite relative image source to use CDN')
    $ = cdn($, options.package)
  }
  return $
}

marky.parsePackageDescription = packagize.parsePackageDescription