.verb.md

Heads up!

Please report all bugs related to markdown-to-HTML conversion on the remarkable issue tracker.

Assemble usage

Visit remarkable for all available features and options.

var remarkable = require('{%= name %}');
var assemble = require('assemble');
var app = module.exports = assemble();

app.task('remarkable', function() {
  return app.src('foo/*.md')
    .pipe(remarkable([options]))
    .pipe(remarkable.unescape()) //<= optionally decode entities after converting to markdown
    .pipe(app.dest('bar'));
});

(.md file extensions are automatically converted to .html)

Gulp usage

Visit remarkable for all available features and options.

var gulp = require('gulp');
var remarkable = require('{%= name %}');

gulp.task('remarkable', function() {
  return gulp.src('foo/*.md')
    .pipe(remarkable([options]))
    .pipe(remarkable.unescape()) //<= optionally decode entities after converting to markdown
    .pipe(gulp.dest('bar'));
});

(.md file extensions are automatically converted to .html)

Options

This plugin uses the following defaults:

(All options are passed to [remarkable][], and all other defaults besides those listed below are the same as remarkable's defaults.)

var defaults = {
  html: true,
  linkify: true,
  highlight: function(code, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        return hljs.highlight(lang, code).value;
      } catch (err) {}
    }

    try {
      return hljs.highlightAuto(code).value;
    } catch (err) {}
    return code;
  }
};

options.highlight

(Differs from remarkable defaults)

[highlight.js][] is used for highlighting code examples by default. Override this or disable it by setting options.highlight to false or any value supported by remarkable.

// disable highlighting
remarkable({highlight: false});

// custom highlighting
remarkable({
  highlight: function() {
    // do highlighting stuff
  }
});