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

metalsmith-gravatar

v0.1.0

Published

A Metalsmith plugin for Gravatar.

Downloads

11

Readme

metalsmith-gravatar

Build Status Dependency Status

A Metalsmith plugin for Gravatar.

This plugin converts email addresses into their associated Gravatar URLs and adds them to Metalsmith's metadata object.

Installation

npm install --save metalsmith-gravatar

Getting Started

If you haven't checked out Metalsmith before, head over to their website and check out the documentation.

CLI Usage

If you are using the command-line version of Metalsmith, you can install via npm, and then add the metalsmith-gravatar key to your metalsmith.json file:

{
  "plugins": {
    "metalsmith-gravatar": {
      "stevenschobert": "[email protected]"
    }
  }
}

JavaScript API

If you are using the JavaScript API for Metalsmith, then you can require the module and add it to your .use() directives:

var gravatar = require('metalsmith-gravatar');

metalsmith.use(gravatar({
  stevenschobert: "[email protected]"
}));

Output

This plugin will a new metadata property named gravatar. This object will contain all the Gravatar URLs you can use in your templates:

<img src="{{gravatar.stevenschobert}}" />

Grouping Avatars

Both the CLI and the JavaScript APIs support nested objects. This allows you to group together multiple avatars into named groups!

{
  "plugins": {
    "metalsmith-gravatar": {
      "authors": {
        "stevenschobert": "[email protected]",
        "malcolmreynolds": "[email protected]"
      },
      "maintainers": {
        "core": { ... },
        "occasional": { ... }
      }
    }
  }
}

Nested objects map directly into the output'ed gravatar object, so you can access them by the same names:

<img src="{{gravatar.authors.stevenschobert}}" />

Options

If you want more control over how the Gravatar URLs are generated, you can specify an options object. If the plugin sees this options object, it will expect the avatars you wish to convert to be in a new avatars object:

{
  "plugins": {
    "metalsmith-gravatar": {
      "options": {
        "protocol": "https"
      },
      "avatars": {
        "stevenschobert": "[email protected]",
        "authors": { ... }
      }
    }
  }
}

Below is a list of options that are supported:

protocol

String - 'http' (default)) or 'https'

Sets the URL prefix for Gravatar images. Useful if you are serving a page via SSL and want to also load the external images via SSL.

Credits

Thanks to Segment.io for creating and open-sourcing Metalsmith!