npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rehype-img-size

v1.0.1

Published

rehype plugin to set local image size properties to img tag

Downloads

31,199

Readme

rehype-img-size

main codecov npm

rehype plugin to set local image size properties to img tag.

This can be used to improve Cumulative Layout Shift: Images without dimensions

Install

npm install rehype-img-size

Use

Say we have the following file, index.md:

![](img.png)

And our script, example.js, looks as follows:

import {unified} from 'unified'
import parse from 'remark-parse'
import remark2rehype from 'remark-rehype'
import stringify from 'rehype-stringify'
import * as vfile from 'to-vfile'
import rehypeImgSize from 'rehype-img-size'

unified()
  .use(parse)
  .use(remark2rehype)
  .use(rehypeImgSize)
  .use(stringify)
  .process(vfile.readSync('index.md'), function(err, file) {
    if (err) throw err
    console.log(file.value)
  })

Now, running node example yields:

<p><img src="img.png" alt="" width="640" height="480"></p>

See examples/esm directory for the entire code.

You can also keep using this as a CommonJS package. See examples/cjs directory.

API

rehype().use(rehypeImgSize[, options])

Add width and height properties to img tag which refers local image file. This plugin read the target file to know the size of the image, so file path must be able to resolve.

Supported formats depend on image-size.

options
options.dir

Directory to resolve image file path. This is useful when Markdown files and image files are located in the separate directories.

nuxt/content

If you use this plugin for nuxt/content, you can use it by configuring your nuxt.config.js like below:

content: {
  markdown: {
    rehypePlugins: [
      [ 'rehype-img-size', { dir: 'static' } ]
    ],

License

MIT © ksoichiro