Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    metalsmith-markdown-remarkablepublic

    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

    Keywords

    none

    install

    npm i metalsmith-markdown-remarkable

    Downloadslast 7 days

    30

    version

    0.1.1

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar