diff --git a/_overviews/scala3-scaladoc/blog.md b/_overviews/scala3-scaladoc/blog.md index be9754820c..9069c9900d 100644 --- a/_overviews/scala3-scaladoc/blog.md +++ b/_overviews/scala3-scaladoc/blog.md @@ -33,4 +33,23 @@ Scaladoc loads blog if the `_blog` directory exists. All the blogpost filenames should start with date in numeric format matching `YYYY-MM-DD`. Example name is `2015-10-23-dotty-compiler-bootstraps.md`. +## Page metadata +The blog pages in scaladoc support [Yaml Frontmatter](https://assemble.io/docs/YAML-front-matter.html) which allows you to specify different values which will be used for metadata in your page. Here are the possible fields: + +``` +--- +layout: +author: +title: +subTitle: <Subtitle of the page> +date: <Date of the creation of the page>, e.g. 2016-12-05 +authorImg: <Link to the author's image> +--- +<Content of your page> +``` + +You can also find more details about the front matter on the [Jekyll documentation site](https://jekyllrb.com/docs/front-matter/). + +## 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/).