Skip to content

Commit de8a49c

Browse files
committed
Corrections: Titles, explanation and nints
1 parent 8056019 commit de8a49c

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

_overviews/scala3-scaladoc/blog.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,35 @@ 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
36+
## Page metadata
3737

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:
3939

4040
```
4141
---
4242
layout: <A reference to the layout page for the blog page>
4343
author: <Name of the author of the page>
4444
title: <Title of the page>
4545
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
4847
authorImg: <Link to the author's image>
4948
---
50-
<Content>
49+
<Content of your page>
5150
```
5251

52+
<!-- Here is an example of a blogpost page with the fields:
53+
![Blog page](https://assets.digitalocean.com/articles/alligator/boo.svg "Scaladoc blog page") -->
54+
5355
## Special characters for the content
5456

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
5662

5763
`## Subtitle` : For subtitles
5864

59-
`word` : To highlight
65+
`word` : For inline code.
6066

6167
`[word](Link to a website)`: If you want to put a link in a word

0 commit comments

Comments
 (0)