Mirrors/ProToots
2
0
Fork 0
mirror of https://github.com/ItsVipra/ProToots synced 2024-09-20 13:51:56 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
47 commits 10 branches 9 tags 711 KiB
JavaScript 84.1%
CSS 11.1%
HTML 4.8%
Find a file
ItsVipra 74daa5d94a Merge branch 'main' of https://github.com/itsvipra/protoots
2023-05-28 12:23:50 +02:00
.github/workflows Add GitHub Action for automatic formatting 2023-05-25 15:45:06 +02:00
.vscode Ensure formatting on save on VS Code 2023-05-27 19:41:27 +02:00
documentation overhaul readme.md 2023-05-28 12:18:37 +02:00
src Merge branch 'main' of https://github.com/itsvipra/protoots 2023-05-28 12:23:50 +02:00
.gitignore initial commit 2023-05-24 18:47:04 +02:00
.node-version initial commit 2023-05-24 18:47:04 +02:00
LICENSE.md Format files using prettier 2023-05-25 22:20:11 +00:00
package-lock.json Explicitly set the name of the package 2023-05-27 19:41:27 +02:00
package.json Explicitly set the name of the package 2023-05-27 19:41:27 +02:00
README.md overhaul readme.md 2023-05-28 12:18:37 +02:00

README.md

ProToots (v1.0)

A Firefox extension which displays an author's pronouns next to their name on Mastodon. A Mastodon screenshot showing off pronouns next to a person's name

Download/Installation

The extension is available on the firefox store!

Alternatively you can download an unsigned version from the releases page.

Known issues

  • Pronouns are not displayed on all notifications. See #25
  • Pronouns are not displayed in the direct messages tab. See #26
  • Pronouns on expanded posts are only shown if they have been cached before.
  • Pronouns are not displayed on replies of an expanded post. See #27

FAQ

Why does ProToots need permission for all websites?

The addon needs to determine whether or not the site you are currently browsing is a Mastodon server. For that to work, it requires access to all sites. Otherwise, each existing Mastodon server would have to be explicitly added.

Why can't i see any ProPlates?

It is likely your instance is not supported. This is because forks of Mastodon all work slightly differently and we cannot account for every version out there. If ProToots isn't working on your instance please tell your admins to contact us here on Github.

ProPlates don't have a background/low contrast on my instance.

Mastodon does not provide set variables for element colors, so we have to adjust the plate styling to each theme. If they're not displaying correctly please tell your admins to follow these steps to style ProPlates

Somebody has added/changed pronouns, why is ProToots still showing no/their old pronouns?

In order to strain your instance less pronouns are cached for 24h, so it might take up to a day to see this change reflected.

Why does the ProPlate just show a link?

When an author only provides their pronouns as a pronouns.page link we display that instead. In the future we'll be able to extract pronouns from the given link. (See #7)

Instance admin info

Protoots aren't working on my instance

what protoots needs (data-id, classnames) issue/pull-request for custom schema

How do I style ProPlates to correctly display on my themes?

You can set their background-color and color attribute for each theme. To do this simply add some CSS to your server. Here's how. See our default styles for reference.

Developer setup