Skip to content

Commit b8ef2d4

Browse files
committed
Add an example
1 parent ce8851f commit b8ef2d4

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

_overviews/scala3-scaladoc/static-site.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,18 @@ getting-started.html
3838
Scaladoc can transform both files and directories (to organize your documentation into a tree-like structure). By default, directories have a title based on the file name and have empty content. It is possible to provide index pages for each section by creating `index.html` or `index.md` (not both) in the dedicated directory.
3939

4040
Before generating your static site you need to set the `-siteroot` value in your doc `scalacOptions`. The value of this is the directory that holds your docs. The root URL for the generated documentation will also be `<site-root>`.
41-
The configuration is as follows:
41+
42+
For example if you have a directory called `docs` and you'd like that to be treated as your site root :
43+
44+
```
45+
.
46+
└── docs/
47+
└── _docs/
48+
├── index.html
49+
└── getting-started.html
50+
```
51+
52+
Then the configuration would be as follows:
4253

4354
```
4455
Compile / doc / scalacOptions ++= Seq("-siteroot", "docs")

0 commit comments

Comments
 (0)