Valid values are of the form: [github|twitter|gitter|discord]::link. Scaladoc also supports custom::link::white_icon_name::black_icon_name. In this case icons must be present in images/ directory.
This issue could be resolved by either:
Updating the Settings page to reflect the change
Re-introducing support for custom social links (possibly tracked via a separate feature request issue)
In the meantime, users may still achieve the effect of custom social links via a workaround. Assuming it is acceptable to sacrifice one of the officially-supported social link types (e.g., github, twitter, gitter, or discord), a user may provide a custom social link for one of the supported social link types. The icon for the chosen social link type can then be replaced in api/images/icon-buttons/$replacedSocialLinkType with the desired custom icon. I have wrapped up this workaround as an sbt task and appended it to the standard Compile / doc task. Unfortunately, I'm not at liberty to share my code at present; if that changes, I'll gladly provide it here.
The Overview of all available settings section of the scaladoc3 settings page indicates that custom social links can be provided. This feature seems to have been removed in May 2022. The change actually shows the documentation was updated to reflect this removal; however, the currently visible settings page does not reflect this, thus misleading readers:
This issue could be resolved by either:
In the meantime, users may still achieve the effect of custom social links via a workaround. Assuming it is acceptable to sacrifice one of the officially-supported social link types (e.g.,
github
,twitter
,gitter
, ordiscord
), a user may provide a custom social link for one of the supported social link types. The icon for the chosen social link type can then be replaced inapi/images/icon-buttons/$replacedSocialLinkType
with the desired custom icon. I have wrapped up this workaround as an sbt task and appended it to the standardCompile / doc
task. Unfortunately, I'm not at liberty to share my code at present; if that changes, I'll gladly provide it here.