Skip to content

Commit

Permalink
Refactor documentation for custom link feature
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucas Leblanc committed Jul 18, 2023
1 parent 5d4b11d commit 6ea99f4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion _overviews/scala3-scaladoc/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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::light_icon_name[::dark_icon_name]`(Dark icon is optional). For example:

`-social-links:scalalang::https://docs.scala-lang.org/::logo-scalalang.png[::logo-scalalang-dark.png]`

In this case icons must be present in `docs/_assets/images/` directory.

##### -skip-by-id

Expand Down

0 comments on commit 6ea99f4

Please sign in to comment.