From 9bb929aba1215e781ea7cb29d972ecabff221c13 Mon Sep 17 00:00:00 2001 From: Lucas Leblanc Date: Wed, 12 Jul 2023 17:06:00 +0200 Subject: [PATCH] Refactor documentation for custom link feature --- _overviews/scala3-scaladoc/settings.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/_overviews/scala3-scaladoc/settings.md b/_overviews/scala3-scaladoc/settings.md index 69ca8b5cdb..7aaacbf803 100644 --- 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