Skip to content

Commit 577410f

Browse files
committed
update readme
1 parent 3946dfb commit 577410f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ Settings allow adding any kind of site you wish:
2525

2626
If you require additional [Font Awesome Icons](https://fontawesome.com/v6/search?o=r&m=free) you can add them to the Additional Icons setting.
2727

28+
## Configuration
29+
30+
This theme component adds these links to the user card and user profile page, so you should un-check the "show on user card" (or profile) checkbox in the custom field setting, otherwise, the link will display twice (once by the profile and once by Discourse).
31+
32+
For sites like Youtube and TikTok that require a @ in the profile URL, include the @ at the end of the URL in the theme settings. The @ gets stripped from the username, so it needs to be included in the URL. BlueSky profiles, which are often referred to as `@handle` resolve to `https://bsky.app/profile/handle` (no `@` in the URL), so this peculiarity is required to have a system that works for both of these cases.
33+
34+
If the theme settings for a site include an icon, the site Title is not displayed. A feature that could be added would add a theme setting to display the title even if an icon exists.
35+
2836
A bunch of the sample settings are provided by AI completion and not tested. You can make changes to the settings yourself, but if you let me know about a broken one (via email or PR) I will be happy to fix it.
2937

3038
Another feature I have considered is making it possible to have entries appear on only the User Card or User Profile, rather than both. If that's of interest, please let me know, especially if you have a budget.

0 commit comments

Comments
 (0)