Skip to content

Commit 557c3fb

Browse files
authored
docs: mention that a local server is needed for scaladocs
1 parent 3dce44f commit 557c3fb

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

_overviews/scala3-scaladoc/static-site.md

+9
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ getting-started.html
3636

3737
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.
3838

39+
Keep in mind that viewing your site locally with all the features it offers, like search or snippets, require a
40+
local server. For example if your output directory was `output` you could use a python server to view everything
41+
by doing the following and opening `localhost:8080`:
42+
43+
```sh
44+
cd output
45+
python3 -m http.server 8080
46+
```
47+
3948
## Properties
4049

4150
Scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine

0 commit comments

Comments
 (0)