eleventy-plugin-mastoarchive v0.2.0

eleventy-plugin-mastoarchive

Fetch your own public posts from Mastodon so you can display them on your personal website.

Getting Started

First install the plugin in your project:

npm i eleventy-plugin-mastoarchive

Then include it in your Eleventy project file

const mastoArchive = require('eleventy-plugin-mastoarchive');

module.exports = (eleventyConfig) => {
  eleventyConfig.addPlugin(mastoArchive, {
    host: MASTODON_SERVER,
    userId: MASTODON_USER_ID,
    removeSyndicates: ['example.com'],
  });

This will expose a global data object called mastodon which you can use in your Eleventy project.

On the first run, the plugin will fetch all your public posts and then cache them to the location specified in cacheLocation. Each time posts are fetched after, only the posts made after the last cached post will be fetched.

If you used versions < 0.2.0 you will need to clear your site's cache to get all your posts and not the most recent 40.

Getting your Mastodon User ID

I was able to retrieve my Mastodon user ID by monitoring the network requests made by the Mastodon server I belong to. On a device that is able to open developer tools, the steps I took were to:

• With the developer tools open and the Network traffic visible, enter your username in the search box and trigger the network request by pressing enter on your keyboard.
• Find the request that looks like https://{mastodon_server}/api/v2/search?q=@{your_mastodon_username} and open the response for that request. The response object should look like the one below.
• Your account should be the first one that appears under accounts. The id of that account is your Mastodon user ID.

{
    "accounts":[
        {
            "id": {your user ID},
            "username": {your Mastodon username},
            ...
        }
    ],
    "statuses":[],
    "hashtags":[]
}

Config Options

The host and userId are required for the plugin to work. The plugin will error if these are not provided.

mastodon global data object

The mastodon object has the following properties:

Mastodon posts

Each Mastodon post has the following properties:

Media objects

If the post contains a one or more images, the media property on the post will contain the following data:

Custom emoji

If your post contains custom emoji, the emoji property will contain the following data: