Skip to content

Commit 6ea99f4

Browse files
author
Lucas Leblanc
committed
Refactor documentation for custom link feature
1 parent 5d4b11d commit 6ea99f4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Diff for: _overviews/scala3-scaladoc/settings.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ Links to social sites. For example:
8989

9090
`-social-links:github::https://github.com/lampepfl/dotty,discord::https://discord.com/invite/scala,twitter::https://twitter.com/scala_lang`
9191

92-
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.
92+
Valid values are of the form: `[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::light_icon_name[::dark_icon_name]`(Dark icon is optional). For example:
93+
94+
`-social-links:scalalang::https://docs.scala-lang.org/::logo-scalalang.png[::logo-scalalang-dark.png]`
95+
96+
In this case icons must be present in `docs/_assets/images/` directory.
9397

9498
##### -skip-by-id
9599

0 commit comments

Comments
 (0)