@chrisburnell/eleventy-cache-webmentions

2.0.1 • Public • Published

eleventy-cache-webmentions

Cache webmentions using eleventy-fetch and make them available to use in collections, layouts, pages, etc. in Eleventy.

Breaking change for v2.0.0

Version 2.0.0 introduces a breaking change for those migrating from earlier versions of the plugin. This affects usage of the plugin from JavaScript files; specifically, you will need to make a small change to the way that you require() the plugin by removing an extra set of parentheses:

v1.2.5 and below

require("@chrisburnell/eleventy-cache-webmentions")()

v2.0.0 and above

require("@chrisburnell/eleventy-cache-webmentions")

Quick Guide

I wrote a quicker and simpler guide to getting this Eleventy plugin working that cuts out all the fluff and extra details.

Check it out: Webmention Setup for Eleventy.

Installation

Inside your Eleventy config file, use addPlugin() to add it to your project:

const pluginWebmentions = require("@chrisburnell/eleventy-cache-webmentions")

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(pluginWebmentions, {
		// These 3 fields are all required!
		domain: "https://example.com",
		feed: "https://webmentions.example.com?token=S3cr3tT0k3n",
		key: "array_of_webmentions"
	})
}

Make sure you get the correct values for this configuration. Check below for both Webmention.io configuration and go-jamming configuration.

Full options list
option default value description version added
domain
required
The website you’re fetching Webmentions for. 0.0.1
feed
required
The URL of your Webmention server’s feed for your domain. 0.2.0
key
required
The key in the above feed whose value is an Array of Webmentions. 0.0.1
directory ".cache" See Eleventy Fetch’s Cache Directory for more information. 1.1.2
duration "1d" or 1 day See Eleventy Fetch’s Cache Duration for more information. 0.0.1
uniqueKey "webmentions" The name of the file generated by Eleventy Fetch. 0.1.9
allowedHTML See code example below See the sanitize-html package for more information. 0.0.1
allowlist [] An Array of root URLs from which Webmentions are kept. 1.1.0
blocklist [] An Array of root URLs from which Webmentions are discarded. 1.1.0
urlReplacements {} An Object of key-value string pairs containing from-to URL replacements on this domain. 0.0.3
maximumHtmlLength 2000 Maximum number of characters in a Webmention’s HTML content, beyond which point a different message is shown, referring to the original source. 0.0.1
maximumHtmlText "mentioned this in" The glue-y part of the message displayed when a Webmention content’s character count exceeds maximumHtmlLength. 0.1.0

Usage

eleventy-cache-webmentions comes with a number of ways of accessing your Webmentions as Global Data in both JavaScript and Liquid/Nunjucks as well as a series of Eleventy Filters and JavaScript Functions for filtering, sorting, and reading properties about each Webmention:

Global Data

JavaScript
const {
	defaults, // default options for the plugin
	webmentionsByUrl, // Object containing Arrays of Webmentions by URL
} = require("@chrisburnell/eleventy-cache-webmentions")
Liquid / Nunjucks
{# default options for the plugin #}
{{ webmentionsDefaults }}
{# Object containing Arrays of Webmentions by URL #}
{{ webmentionsByUrl }}

Filters

JavaScript
const {
	getWebmentions, // get Array of Webmentions for a given URL
	getByTypes, // filter Webmentions by their response type
	getPublished, // get received/published time of a Webmention
	getContent, // get content of a Webmention
	getSource, // get source URL of a Webmention (where it's from)
	getTarget, // get target URL of a Webmention (where it's sent to)
	getType, // get response type of a Webmention
} = require("@chrisburnell/eleventy-cache-webmentions")

// This is NOT the best way to get Webmentions!
// See "Attach Webmentions to Pages using Directory Data" below.
const webmentions = getWebmentions({
	domain: "https://example.com",
	feed: "https://webmentions.example.com?token=S3cr3tT0k3n",
	key: "array_of_webmentions"
}, "https://example.com/specific-page/")

const responsesOnly = getByTypes(webmentions, ['mention-of', 'in-reply-to'])

webmentions.forEach((webmention) => {
	const published = getPublished(webmention)
	const content = getContent(webmention)
	const source = getSource(webmention)
	const target = getTarget(webmention)
	const type = getType(webmention)
})
Liquid / Nunjucks
{# get Array of Webmentions for a given URL #}
{% set webmentions = ("https://example.com" + page.url) | getWebmentions %}

{# filter Webmentions by their response type #}
{{ set responses = webmentions | getWebmentionsByTypes(['mention-of', 'in-reply-to']) }}

{% for webmention in webmentions %}
    {# get received/published time of a Webmention #}
    {{ webmentions | getWebmentionPublished }}
    {# get content of a Webmention #}
    {{ webmentions | getWebmentionContent }}
    {# get source URL of a Webmention (where it's from) #}
    {{ webmentions | getWebmentionSource }}
    {# get target URL of a Webmention (where it's sent to) #}
    {{ webmentions | getWebmentionTarget }}
    {# get response type of a Webmention #}
    {{ webmentions | getWebmentionType }}
{% endfor %}

Attach Webmentions to Pages using Directory Data

Using Eleventy’s Data Cascade, you can attach Webmentions to each page by using Directory Specific Data Files.

For example, if you have a folder, /pages/, and want to attach Webmentions to each page, create or add the following to a pages.11tydata.js file within the folder:

const { getWebmentions, getPublished } = require("@chrisburnell/eleventy-cache-webmentions")

module.exports = {
	eleventyComputed: {
		webmentions: (data) => {
			// Get this page's Webmentions as an Array (based on the URL)
			const webmentionsForUrl = getWebmentions({
				domain: "https://example.com",
				feed: "https://webmentions.example.com?token=S3cr3tT0k3n",
				key: "array_of_webmentions"
			}, "https://example.com" + data.page.url)

			// If there are Webmentions for this page
			if (webmentionsForUrl.length) {
				// Sort them (based on when they were received/published)
				return webmentionsForUrl.sort((a, b) => {
					return getPublished(b) - getPublished(a)
				})
			}
			// Otherwise, return an empty Array
			return []
		},
	},
}

This attaches an Array containing Webmentions to each page (based on its URL). You can then access this Array of Webmentions with the variable, webmentions, within a Layout, Include, or from the page itself:

{% for webmention in webmentions %}
    {# Do something with each Webmention #}
{% endfor %}

These Arrays of Webmentions can even be accessed when building Collections, allowing you to create a Collection of pages sorted by their number of Webmentions, for example:

module.exports = (eleventyConfig) => {
	eleventyConfig.addCollection("popular", (collection) => {
		return collection
			.sort((a, b) => {
				return b.data.webmentions.length - a.data.webmentions.length
			})
	})
}

Without Directory Data

If you would rather get Webmentions for a given page directly from a Layout/Include/Page itself, you can do so using the Filter, getWebmentions:

{% set webmentions = ("https://example.com" + page.url) | getWebmentions %}
{% for webmention in webmentions %}
    ...
{% endfor %}

Get specific types of Webmentions

Instead of getting all the Webmentions for a given page, you may want to grab only certain types of Webmentions. This is useful if you want to display different types of Webmentions separately, e.g.:

{% set bookmarks = webmentions | getTypes(['bookmark-of']) %}
{% set likes = webmentions | getTypes(['like-of']) %}
{% set reposts = webmentions | getTypes(['repost-of']) %}

{% set replies = webmentions | getTypes(['mention-of', 'in-reply-to']) %}

Get all Webmentions at once

If you need it, the plugin also makes available an Object containing your cached Webmentions organised in key:value pairs, where each key is a full URL on your website and its value is an Array of Webmentions sent to that URL:

{% set count = 0 %}
{% for url, array in webmentionsByUrl %}
	{% set count = array.length + count %}
{% endfor %}
<p>This website has received {{ count }} Webmentions!</p>

Webmention.io

Webmention.io is a in-place Webmention receiver solution that you can use by authenticating yourself via IndieAuth (or host it yourself), and, like so much other publicly-available IndieWeb software, is built and hosted by Aaron Parecki.

Add your token

Get set up on Webmention.io and add your API Key (found on your settings page) to your project as an environment variable, i.e. in a .env file in the root of your project:

WEBMENTION_IO_TOKEN=njJql0lKXnotreal4x3Wmd

Set your feed and key config options

The example below requests the JF2 file format, which I highly recommend using; although, there is a JSON format available from Webmention.io as well. The official documentation has more information on how to use these two formats.

The key difference between the two feed formats is in the naming of the keys: the JF2 format holds the array of Webmentions in the children key, whereas the JSON format holds them in the links key. The JF2 format, however, provides keys and values that more tightly-align with microformats, the method I recommend the most for marking up HTML such that it can be consumed and understood by search engines, aggregators, and other tools across the Indieweb.

const pluginWebmentions = require("@chrisburnell/eleventy-cache-webmentions")

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(pluginWebmentions, {
		domain: "https://example.com",
		feed: `https://webmention.io/api/mentions.jf2?domain=example.com&per-page=9001&token=${process.env.WEBMENTION_IO_TOKEN}`,
		key: "children"
	})
}

If you want to use the JSON format instead, make sure that you replace mentions.jf2 in the URL with mentions.json and change the value of the key from children to links.

go-jamming

go-jamming is a self-hosted Webmention sender and receiver, built in Go by Wouter Groeneveld and available with more information on his personal git instance.

Add your token

Once you’ve set up your go-jamming server and you’ve defined your token, you’ll need add it to your project as an environment variable, i.e. in a .env file in the root of your project:

GO_JAMMING_TOKEN=njJql0lKXnotreal4x3Wmd

Set your feed and key config options

const pluginWebmentions = require("@chrisburnell/eleventy-cache-webmentions")

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(pluginWebmentions, {
		domain: "https://example.com",
		feed: `https://jam.example.com/webmention/example.com/${process.env.GO_JAMMING_TOKEN}`,
		key: "json"
	})
}

Contributing

Contributions of all kinds are welcome! Please submit an Issue on GitHub or get in touch with me if you’d like to do so.

License

This project is licensed under an MIT license.

Package Sidebar

Install

npm i @chrisburnell/eleventy-cache-webmentions

Weekly Downloads

13

Version

2.0.1

License

MIT

Unpacked Size

26.2 kB

Total Files

5

Last publish

Collaborators

  • chrisburnell