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

@manustays/eleventy-plugin-generate-social-images

v4.1.0

Published

Dynamically generate social media images for your Eleventy blog pages.

Downloads

137

Readme

Eleventy Plugin: Generate Social Images (using SVG)

Dynamically generate social media images for your Eleventy blog pages. Unlike other similar plugins, this one uses SVG & does not depend on Puppeteer!

GitHub issues npm (scoped) About Abhishek Twitter Follow


  1. Introduction
  2. Why another social-image generator?
  3. How does it work?
  4. Installation and Usage
  5. Config Options
  6. Custom Fonts
  7. Todo
  8. Credits

Introduction

This plugin provides an 11ty ShortCode that can be used to automatically generate social images in your Eleventy website or blog.

For example:

{% GenerateSocialImage "Eleventy plugin for generating social images (using SVG)" %}

will generate the following social image (website-name and author-image are set during configuration):

The social image is first created as SVG and then converted to PNG using Sharp.

Why another social-image generator?

There is already a very good plugin eleventy-plugin-social-images by Stephanie Eckles who has written a very good article about her approach. The plugin is very customizable and can serve most people very well.

I created a new plugin because the above mentioned plugin...

  • uses Puppeteer to generate the image from a webpage.
    • I faced some issues running Puppeteer on WSL2, so decided to get rid of the dependency.
  • uses a separate build process to generate the images.
    • While it is totally fine (even better, as it can be used with any other SSG), I wanted the workflow within the Eleventy build process, i.e, by using an Eleventy ShortCode.

How does it work?

  • Generates the image using SVG and then converts it into PNG using Sharp.
  • Custom logic to wrap the title line in SVG (as Sharp does not support SVG foreignObject).
  • Adds an author/promo image using Sharp composite (as Sharp does not support external image in SVG).

Installation and Usage

STEP 1: Install the package:

npm install @manustays/eleventy-plugin-generate-social-images

STEP 2: Include it in your .eleventy.js config file:

const generateSocialImages = require("@manustays/eleventy-plugin-generate-social-images");

module.exports = (eleventyConfig) => {
  eleventyConfig.addPlugin(generateSocialImages, {
    promoImage: "./src/img/my_profile_pic.jpg",
    outputDir: "./_site/img/preview",
    urlPath: "/img/preview",
	siteName: "abhi.page/",
	titleColor: "#fedb8b"
  });
};

Step 3: Use in your template

For example, in your base.njk template file, use it in the <head> for generating social image meta tags:

<meta property="og:image" content="{% GenerateSocialImage title %}" />
<meta name="twitter:image" content="{% GenerateSocialImage title %}" />

Note: For a complete implementation example, checkout my website on Github.

Config Options

| Option | Type | Default | Description | | ----------- | ------ | ------------- |-------------| | promoImage | string | | Path to a promo Image (ideally, circular) that will be embedded in the social-images | | outputDir | string | "./_site/img/preview" | Project-relative path to the output directory where images will be generated | | urlPath | string | "/img/preview" | A path-prefix-esque directory for the <img src> attribute. e.g. /img/ for <img src="/img/MY_IMAGE.jpeg"> | | siteName | string | | The website name to show on the social-image | | titleColor | string | "white" | The color of the page-title | | bgColor | string | | Optional background color. Otherwise, shows the gradient pattern | | terminalBgColor| string | "#404040" | Background color of the terminal window design | | hideTerminal | boolean | false | If true, hides the terminal window design behind the title | | customSVG | string | | Custom SVG code to be added to the image. Use this to add your own design or text anywhere on the image | | customFontFilename | string | | Filename of custom local font used for title (see Custom Fonts) | | lineBreakAt | number | 35 | Maximum row length for wrapping the title. Required because SVG does not have auto-wrapping text. Should depends on the font used |

Custom Fonts

The Sharp library uses librsvg that uses fontconfig to load external fonts. Therefore, the following steps are required:

  1. Download your font file in project sub-folder. Eg: ./fonts/sans.ttf
  2. Create a file fonts.conf with the following content:
     <?xml version="1.0"?>
     <!DOCTYPE fontconfig SYSTEM "fonts.dtd">
     <fontconfig>
     	<dir prefix="default">fonts</dir>
     </fontconfig>
  3. Setup the following environment variable on your build server (eg: Netlify):
    FONTCONFIG_PATH=.

TODO

  • [ ] Cache result to avoid regenerating same image
  • [x] Better text-wrap logic for the page-title in SVG
  • [x] Custom SVG
  • [x] Custom font
  • [ ] More customization options!

Credits