Nineteen Poor Moths

    @centerforopenscience/markdown-it-imsize

    2.0.1 • Public • Published

    markdown-it-imsize

    Build Status NPM version Coverage Status Dependency Status devDependency Status

    A markdown-it plugin for size-specified image markups. This plugin overloads original image renderer of markdown-it.

    Usage

    Enable plugin

    var md = require('markdown-it')({
      html: true,
      linkify: true,
      typography: true
    }).use(require('markdown-it-imsize')); // <-- this use(package_name) is required

    Example

    ![test](image.png =100x200)

    is interpreted as

    <p><img src="image.png" alt="test" width="100" height="200"></p>

    Options

    Auto fill

    var md = require('markdown-it')({
      html: true,
      linkify: true,
      typography: true
    }).use(require('markdown-it-imsize'), { autofill: true });

    will fill the width and height fields automatically if the specified image path is valid.

    Therefore,

    ![test](image.png)

    is interpreted as

    <p><img src="image.png" alt="test" width="200" height="200"></p>

    where image.png is a valid path and its size is 200 x 200.

    Use with RequireJS

    markdown-it-imsize is available with bower and RequireJS. First, you can install the package with,

    bower install markdown-it-imsize

    Script for using markdown-it-imsize with RequireJS is like,

    require(['require', 'MarkdownIt', 'MarkdownItImsize'], function(require) {
      var md = require('MarkdownIt')({
        html: true,
        linkify: true,
        typography: true
      }).use(require('MarkdownItImsize'));
    
      var rendered = md.render("![test](test.jpg =100x)");
      document.getElementById('image-box').innerHTML = rendered;
    });

    Install

    npm i @centerforopenscience/markdown-it-imsize

    DownloadsWeekly Downloads

    1,275

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    604 kB

    Total Files

    40

    Last publish

    Collaborators

    • mattcos
    • aaxelb
    • jamescdavis
    • brianjgeiger
    • cosopsadmin