Skip to content

Commit 31e3aac

Browse files
authored
Add description for dynamic-side-menu scaladoc option (#2942)
1 parent 097c4f9 commit 31e3aac

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

_overviews/scala3-scaladoc/settings.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,18 @@ Which means:
172172
- all snippets in files under directory `my/path/f` should fail during compilation
173173
- all other snippets should compile successfully
174174

175-
#### -scastie-configuration
175+
##### -scastie-configuration
176176

177177
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.
178178

179179
```
180180
"-scastie-configuration", """libraryDependencies += "org.apache.commons" % "commons-lang3" % "3.12.0""""
181181
```
182182

183+
##### -dynamic-side-menu
184+
185+
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).
186+
183187
##### -Ysnippet-compiler-debug
184188

185189
Setting this option makes snippet compiler print the snippet as it is compiled (after wrapping).

0 commit comments

Comments
 (0)