Skip to content

Add a documentation for the blog.yml feature #2796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions _overviews/scala3-scaladoc/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,24 @@ You can also find more details about the front matter on the [Jekyll documentati

## Syntax of the content
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/).

## Blog configuration
When creating your blog, Scaladoc also allows you to configure it.

In order to modify the default settings of the blog documentation, users need to create a file named `blog.yml` 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:

```
input: my_posts
output: my_docs
hidden: true
```

### Parameters:

`input`: specifies the directory containing markdown files for the blog posts (default: "_posts" in "docs").

`output`: specifies the folder where HTML pages will be generated (default: "blog" in "target/docs").

`hidden`: allows users to temporarily hide the blog (default: "false").

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.