Skip to content

Commit c94f911

Browse files
committed
Add a documentation for the blog.yaml feature
1 parent 86fe255 commit c94f911

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

_overviews/scala3-scaladoc/blog.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,25 @@ You can also find more details about the front matter on the [Jekyll documentati
5353

5454
## Syntax of the content
5555
Keep in mind that the writing of your blog is done with Markdown. You can find more information about the syntax in [Markdown Guide](https://www.markdownguide.org/basic-syntax/).
56+
57+
## Blog configuration
58+
When creating your blog, Scaladoc also allows you to configure it.
59+
60+
In order to modify the default settings of the blog documentation, users need to create a file named `blog.yaml` in the **root directory of the blog**. The file should contain the parameters that the user wants to change. For example, if a user wants to change the input directory to "my_posts", the output directory to "my_docs", and temporarily hide the blog, they can create a file with the following content:
61+
62+
63+
```
64+
input: my_posts
65+
output: my_docs
66+
hidden: true
67+
```
68+
69+
### Parameters:
70+
71+
`input`: specifies the directory containing markdown files for the blog posts (default: "_posts" in "docs").
72+
73+
`output`: specifies the folder where HTML pages will be generated (default: "blog" in "target/docs").
74+
75+
`hidden`: allows users to temporarily hide the blog (default: "false").
76+
77+
To change these settings, create a file with the parameters and save it in the blog's root directory. The next time the blog is built, the new settings will be used.

0 commit comments

Comments
 (0)