README.md

eleventy-plugin-inline-tweet

This plugin will transform a text anywhere in your content that looks like:

inlineTweet:https://twitter.com/code_conf/status/651724049463312384

Into the inlined HTML of the tweet, with no external JavaScript needed, with styles inlined and smaller images also inlined. Only large images will not be inlined.

Example of inlined tweet

You can also see it in use at the bottom of my Danish page about my speaking engagements at itforedrag.dk. The code for that page is availabel on Github foredrag

Why

Why would you want to inline the html of the tweet, instead of just using the embed functionality on twitter? By inlining the html of the tweet:

1. You are removing external dependency on the twitter javascript. Using an external JavaScript both slows your page down and has security implications.
2. It becomes possible to implement an effective lazyload of images
3. You eliminate the page jumping up and down during hot reload development cycles, where the twitter javascript otherwise would be fetching the inlineded tweet again and again as you hot reload the page ever time you make a change.

Disadvantages

There are some disadvantages to inlinedint the html of tweets

1. The like counter does not update automatically anymore. You will need to delete the cache at ./inlineTweet.json and rebuild the page to get updated counters.
2. If twitter changes the layout of inlineded tweets to some kind of better version, you will still be on the version from when you inlineded the tweet.

Installation

Available on npm.

npm install eleventy-plugin-inline-tweet

Open up your Eleventy config file (probably .eleventy.js) and use addPlugin:

const inlineTweetPlugin = require("eleventy-plugin-inline-tweet");

module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(inlineTweetPlugin);
};

Read more about Eleventy plugins.