Skip to content

Commit 61c3497

Browse files
committed
Improve documentation for Built-in Blog doc, add Structure and special characters parts
1 parent a20b96f commit 61c3497

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

_overviews/scala3-scaladoc/blog.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,28 @@ 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+
## Structure
3637

38+
```
39+
---
40+
layout: A reference to the layout for the blog page
41+
author: Name of the author of the page
42+
title: Name of the author of the page
43+
subTitle: Subtitle of the page
44+
excerpt_separator: <!--more-->
45+
date: Date of creation of the page
46+
authorImg: Image of the author of the page
47+
---
48+
<Content>
49+
```
50+
Keep in mind that with the exception of the author's name and title, the fields are optional.
51+
52+
## Special characters for structures
53+
54+
````<content>```` : For code
55+
56+
`##Subtitle` : For subtitles
57+
58+
`word` : To highlight
59+
60+
`[word](Link to a website)`: If you want to put a link in a word

0 commit comments

Comments
 (0)