You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _overviews/scala3-scaladoc/blog.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,29 +33,35 @@ Scaladoc loads blog if the `_blog` directory exists.
33
33
All the blogpost filenames should start with date in numeric format matching `YYYY-MM-DD`.
34
34
Example name is `2015-10-23-dotty-compiler-bootstraps.md`.
35
35
36
-
## Structure
36
+
## Page metadata
37
37
38
-
When creating a blog page, you will have a first part to fill in with different fields. See the following example:
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
39
40
40
```
41
41
---
42
42
layout: <A reference to the layout page for the blog page>
43
43
author: <Name of the author of the page>
44
44
title: <Title of the page>
45
45
subTitle: <Subtitle of the page>
46
-
excerpt_separator: <!--more-->
47
-
date: <Date of the creation of the page>
46
+
date: <Date of the creation of the page>, e.g. 2016-12-05
48
47
authorImg: <Link to the author's image>
49
48
---
50
-
<Content>
49
+
<Content of your page>
51
50
```
52
51
52
+
<!-- Here is an example of a blogpost page with the fields:
53
+
 -->
54
+
53
55
## Special characters for the content
54
56
55
-
` ```<content>``` ` : For code
57
+
` ```<content>``` ` : Multiline code block
58
+
You can also specify a language type.
59
+
` ```scala <content>``` `
60
+
61
+
`# Title` : For titles
56
62
57
63
`## Subtitle` : For subtitles
58
64
59
-
`word` : To highlight
65
+
`word` : For inline code.
60
66
61
67
`[word](Link to a website)`: If you want to put a link in a word
0 commit comments