Home
Softono
fedi-badge

fedi-badge

Open source TypeScript
49
Stars
1
Forks
0
Issues
1
Watchers
1 week
Last Commit

About fedi-badge

A badge generator for ActivityPub-enabled social media platforms, i.e., fediverse

Platforms

Web Self-hosted

Languages

TypeScript

Fedi badge

This is a simple badge generator for ActivityPub-enabled social media platforms, i.e., fediverse. It is inspired by Shields.io and is intended to be used in a similar way. It does not support only Mastodon, but also other platforms like Pleroma, Misskey, Pixelfed, and so on.[^1]

Here is an example of fedi badges:

https://fedi-badge.minhee.org/@[email protected]/following.svg

@hongminhee@hollo.social

https://fedi-badge.minhee.org/@[email protected]/followers.svg

@hongminhee@hackers.pub

https://fedi-badge.minhee.org/@[email protected]/posts.svg

@hongminhee@fosstodon.org

https://fedi-badge.minhee.org/@[email protected]/followers.svg

@hongminhee@misskey.io

The pattern of the URL is:

https://fedi-badge.minhee.org/@USER@DOMAIN/followers.svg
https://fedi-badge.minhee.org/@USER@DOMAIN/following.svg
https://fedi-badge.minhee.org/@USER@DOMAIN/posts.svg

The badge automatically shows the logo of the software running on the instance (e.g., Mastodon, Misskey, Pleroma) on the left side, detected via NodeInfo. If the software is not recognized or NodeInfo is unavailable, a generic fediverse logo is used instead.

Optionally, you can specify the following options in the query string:

  • label: The label of the badge. If not specified, it will be @USER@DOMAIN.
  • style: The style of the badge. It can be one of plastic, flat, flat-square, for-the-badge, social. If not specified, it will be social.

Example:

https://fedi-badge.minhee.org/@USER@DOMAIN/followers.svg?style=flat

Note that each badge is cached for an hour, so you may not see the immediate change after your social media activity.

[^1]: Unless you configured your following/followers to be private.