Skip to content

Commit 0ed4bba

Browse files
authored
Merge pull request #2708 from Dedelweiss/improve_doc_build_blog
Fix: Improve documentation for Built-in Blog doc
2 parents 2c756b1 + 5a671d1 commit 0ed4bba

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

_overviews/scala3-scaladoc/blog.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,23 @@ Scaladoc loads blog if the `_blog` directory exists.
3333
All the blogpost filenames should start with date in numeric format matching `YYYY-MM-DD`.
3434
Example name is `2015-10-23-dotty-compiler-bootstraps.md`.
3535

36+
## Page metadata
3637

38+
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:
39+
40+
```
41+
---
42+
layout: <A reference to the layout page for the blog page>
43+
author: <Name of the author of the page>
44+
title: <Title of the page>
45+
subTitle: <Subtitle of the page>
46+
date: <Date of the creation of the page>, e.g. 2016-12-05
47+
authorImg: <Link to the author's image>
48+
---
49+
<Content of your page>
50+
```
51+
52+
You can also find more details about the front matter on the [Jekyll documentation site](https://jekyllrb.com/docs/front-matter/).
53+
54+
## Syntax of the content
55+
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/).

0 commit comments

Comments
 (0)