README.md

Warning

This repository is no longer maintained.

metalsmith-markdown-remarkable

A Metalsmith plugin to convert markdown files via Remarkable. Derived from metalsmith-markdown.

Installation

npm install metalsmith-markdown-remarkable

Warning: Remarkable version

If you care about what Remarkable is bundled herein, please note:

• v1.* of this plugin now use Remarkable 1.*
• v2.* use Remarkable 2.*

(Remarkable was originally – and carelessly – upgraded to 2.0 in v1.0.1, now deprecated. Thanks to @jja for the heads-up.)

CLI usage

Add metalsmith-markdown-remarkable to your metalsmith.json plugins with any Remarkable options you want:

{
  "plugins": {
    "metalsmith-markdown-remarkable": {
      "breaks": true,
      "typographer": true,
      "quotes": "«»‘’"
    }
  }
}

Javascript usage

Pass the plugin to Metalsmith via use(), optionally setting Remarkable preset and options (or just the latter):

var markdown = require('metalsmith-markdown-remarkable');

metalsmith.use(markdown('full', {
  breaks: true,
  typographer: true,
  quotes: '«»‘’'
}));

Passing Remarkable plugins

The plugin also defines a use() function, which passes whatever you give it to Remarkable's own use():

metalsmith.use(markdown().use(remarkablePlugin));

If you have multiple Remarkable plugins, just chain calls:

metalsmith.use(markdown().use(plugin1).use(plugin2));

License

MIT