Refactor documentation for custom link feature

scala · Jul 12, 2023 · 9bb929a · 9bb929a
1 parent cd240a8
commit 9bb929a
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/_overviews/scala3-scaladoc/settings.md b/_overviews/scala3-scaladoc/settings.md
@@ -89,7 +89,11 @@ Links to social sites. For example:
 
 `-social-links:github::https://github.com/lampepfl/dotty,discord::https://discord.com/invite/scala,twitter::https://twitter.com/scala_lang`
 
-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.
+Valid values are of the form: `[github|twitter|gitter|discord]::link`. Scaladoc also supports `custom::link::white_icon_name[::black_icon_name]`(Black icon is optional). For example:
+
+`-social-links:scalalang::https://docs.scala-lang.org/::logo-scalalang.png` or `-social-links:scalalang::https://docs.scala-lang.org/::logo-scalalang.png::logo-scalalang-black.png`
+
+In this case icons must be present in `docs/_assets/images/` directory.
 
 ##### -skip-by-id