-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
59 lines (39 loc) · 2.75 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
=== Mastodon Social Icons ===
Contributors: triumvirate
Tags: mastodon, social, svg
Requires at least: 5.3
Tested up to: 6.1
Requires PHP: 5.6
License: GPLv2
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Stable tag: 0.1.0
This plugin replaces footer menu URLs of the top-100 (by user) Mastodon domains (as of plugin publication) with the Mastodon logo SVG via the social icon mechanism.
== Description ==
It's aesthetically pleasing to link Wordpress sites to one's Mastodon account by adding a link in the site footer menu to one's Mastodon profile that's replaced with the "M" mastodon trunk/word balloon-logo.
Without this plugin, however, this functionality is not [expected](https://core.trac.wordpress.org/ticket/57293#ticket) to work for any Mastodon domains until 6.2, and at that point, only the top-10-by-volume Mastodon domains.
This plugin allows replacing the top-100 (by user) Mastodon domains (as of plugin publication) with the Mastodon logo SVG [via this mechanism](https://wordpress.org/documentation/article/twenty-twenty-one/#add-social-icons):
> the text label you provide will be hidden, and an icon will be shown in its place.
== Current Limitations ==
1. Currently only works with [twenty-twenty-one](https://wordpress.org/themes/twentytwentyone/) theme and later
2. Non-top-100 domains were queried at plugin publishing time (2023-02-18) from `instances.social`: `'https://instances.social/api/1.0/instances/list?count=0&include_closed=true&include_down=false&sort_by=users&sort_order=desc`
[I (or anyone else) can work to address these limitations if there is interest.](https://github.com/ijoseph/mastodon_social_icons)
== Example ==
See [here](https://github.com/ijoseph/mastodon_social_icons#2-example) for the example with screenshots inline.
= 1. Set up Theme: Twenty Twenty-One =
![IMAGE](resources/4AEB4EF9A534C8558066B50431235B39.jpg)
= 2 Create a Secondary Menu =
![IMAGE](resources/29814690F191FD62DA0C84BF7F57EC8E.jpg)
= 3 Add custom links =
![IMAGE](resources/29E648FD11A29AAC255AFCD7CCD5B3FF.jpg)
= 4 Before =
![IMAGE](resources/BE58DA1D427AEF5DD6DE8A9FE43B0929.jpg)
The `mastodon.com` logo is (erroneously, as it is not a true mastodon domain) is replaced by the `svg`, but a `mastodon.social` link is _not_.
= 5 After =
== Screenshots ==
1. `mastodon.social` link in footer is replaced with Mastodon icon! (Mastodon.com is not, which [is correct behavior](https://www.mastodon.com/)).
= 5.1 Activate Plugin =
![IMAGE](resources/AF1B8894E54D3052195D30AF309A9B04.jpg)
![IMAGE](resources/3B32E5D7906E97EF656674BE53B46D3D.jpg)
notice that `mastodon.com` (not a true mastodon domain) is not replaced, but that a `mastodon.social` link _is_ replaced.
== Support ==
Open an [issue on github](https://github.com/ijoseph/mastodon_social_icons/issues).