Gulp-remarkable NPM

Gulp Remarkable

A gulp plugin for Remarkable - Markdown parser, done right. Fast and easy to extend. Supports CommonMark.

Installation

Install using npm:

$ npm install gulp-remarkable

See gulp-remarkable on npm.

Options

remarkableOptions {Object} Options to be passed to Remarkable
disable Array Options to be passed to md.core.ruler.disable
- to use it, first remarkableOptions.typographer must be set to true
preset {String} Remarkable's preset, default full

Usage

Default Example

var gulp = require('gulp'),
    name = require('gulp-rename'),
    md   = require('gulp-remarkable');

gulp.task('md', function() {
  return gulp.src('file.md')
    .pipe(md({preset: 'commonmark'}))
    .pipe(name('file.html'))
    .pipe(gulp.dest('dist'));
});

gulp.task('default', ['md']);

Extended Example

var gulp = require('gulp'),
    name = require('gulp-rename'),
    md   = require('gulp-remarkable');

gulp.task('md', function() {
  return gulp.src('file.md')
    .pipe(md({
      preset: 'full',
      disable: ['replacements'],
      remarkableOptions: {
        typographer: true,
        linkify: true,
        breaks: true
      }
    }))
    .pipe(name('file.html'))
    .pipe(gulp.dest('dist'));
});

gulp.task('default', ['md']);

Using Plugins

gulp-remarkable accepts one or two parameters: options and an optional function that accepts gulpRemarkable object.

var gulp = require('gulp')
var md = require('gulp-remarkable')

return gulp.src(globMarkdown)
    .pipe(md(opts, (m=>{
      m.renderer.rules.heading_open = headingAnchorRendererPlugin
    })))

function headingAnchorRendererPlugin(tokens, idx ) {
  if (tokens[idx+1].type == 'inline') {
    let heading_anchor = slug(tokens[idx+1].content, {lower: true})
    return '<h' + tokens[idx].hLevel + ' id="' + heading_anchor + '">';
  }
  return '<h' + tokens[idx].hLevel + '>';
}