Skip to content

Fix: Improve documentation for Built-in Blog doc #2708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 15, 2023
Merged

Fix: Improve documentation for Built-in Blog doc #2708

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
61c3497
Improve documentation for Built-in Blog doc, add Structure and specia…
Dedelweiss Feb 26, 2023
8056019
Corrections
Dedelweiss Mar 1, 2023
de8a49c
Corrections: Titles, explanation and nints
Dedelweiss Mar 2, 2023
2fbf717
Correction
Dedelweiss Mar 2, 2023
41a99c2
Delete comment
Dedelweiss Mar 6, 2023
6e89d61
Corrections of some nits
Dedelweiss Mar 6, 2023
5b5ebe9
Change the sentence line 53
Dedelweiss Mar 11, 2023
5a671d1
Remove examples in Special characters part
Dedelweiss Mar 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions _overviews/scala3-scaladoc/blog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <A reference to the layout page for the blog page>
author: <Name of the author of the page>
title: <Title of the page>
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/).