A Metalsmith plugin to convert markdown files via Remarkable
JavaScript Makefile
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.npmignore
README.md
makefile
package.json

README.md

metalsmith-markdown-remarkable

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

npm

Installation

npm install metalsmith-markdown-remarkable

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