README

Display posts from Mastodon on your Kirby-powered site. Includes a variety of configuration options and caching for improved performance.

Installation

Kirby CLI

kirby plugin:install scottboms/mastodon-feed

Git Submodule

$ git submodule add https://github.com/scottboms/kirby-mastodon-feed.git site/plugins/mostadon-feed

Copy and Paste

1. Download the contents of this repository as Zip file.
2. Rename the extracted folder to mastodon-feed and copy it into the site/plugins/ directory in your Kirby project.

Usage

Add the following line to include the built-in snippet to your site. You can customize the HTML formatting by creating a snippet with the same name in your /site/snippets/ folder.

<?= snippet('mastodon_feed') ?>

Template Output

If you want to explore the data returned via the plugin to the snippet or that you can render directly in a template, you can use the following to output the contents of the $feed object returned.

<pre>
	<?php print_r($items->toArray()); ?>
</pre>

Configuration Options

Date formatting follows the available format options from PHP.

Example Config:

<?php
  return [
    'cache' => [
      'scottboms.mastodon' => [
        'type' => 'file',
      ]
    ],

	  'scottboms.mastodon' => [
      'username'   => 'scottboms',
      'instance'   => 'mastodon.social',
      'dateformat' => 'm-d-Y',
      'cache'      => true,
      'cachettl'   => 300 // 5 minutes
      'onlymedia'  => true,
      'panel'      => [
        'limit' => 6
      ]
    ]
  ]

Panel View Button

The plugin includes a custom Panel View Button for Kirby 5.x to manually clear the Mastodon cache file which can be added to the site or a page blueprint using the buttons option.

buttons:
  mastodoncache: true

Compatibility

• Kirby 4.x
• Kirby 5.x

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test before using it in a production environment. If you identify an issue, typo, etc, please create a new issue so I can investigate.

License

MIT