From 8aee29dd4e74ac678818bc2519a07ca2fe6fbd96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miko=C5=82aj=20Fornal?= <24961583+Florian3k@users.noreply.github.com> Date: Tue, 2 Jan 2024 15:32:15 +0100 Subject: [PATCH] Add description for dynamic-side-menu scaladoc option --- _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 9408e6d9ce..e5118ab430 100644 --- a/_overviews/scala3-scaladoc/settings.md +++ b/_overviews/scala3-scaladoc/settings.md @@ -172,7 +172,7 @@ Which means: - all snippets in files under directory `my/path/f` should fail during compilation - all other snippets should compile successfully -#### -scastie-configuration +##### -scastie-configuration Define the additional sbt configuration for your Scastie snippets. For example, when you import external libraries into your snippets, you need to add the related dependencies. @@ -180,6 +180,10 @@ Define the additional sbt configuration for your Scastie snippets. For example, "-scastie-configuration", """libraryDependencies += "org.apache.commons" % "commons-lang3" % "3.12.0"""" ``` +##### -dynamic-side-menu + +Generate the side menu (the tree-like overview of the project structure on the left-hand side) dynamically in the browser using JavaScript instead of embedding it in every HTML file. This can greatly reduce outputted HTML file sizes. Recommended for projects with 1000+ pages. For more info see [issue 18543](https://github.com/lampepfl/dotty/issues/18543). + ##### -Ysnippet-compiler-debug Setting this option makes snippet compiler print the snippet as it is compiled (after wrapping).