assemble-remarkable

Assemble pipeline plugin for remarkable, the markdown converter for node.js. Can also be used with gulp.

You might also be interested in gulp-breakdance.

Install

Install with npm:

$ npm install --save assemble-remarkable

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('assemble-remarkable');
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('assemble-remarkable');

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
  }
});

About

Related projects

• breakdance: Breakdance is a node.js library for converting HTML to markdown. Highly pluggable, flexible and easy… more | homepage
• gulp-html-toc: Gulp plugin for html-toc, for generating a HTML table of contents. | homepage
• gulp-htmlmin: gulp plugin to minify HTML. | homepage
• gulp-remarkable: Gulp plugin for Remarkable - Markdown parser done right. Fast and easy to extend. Supports… more | homepage
• remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on June 22, 2017.