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.

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
Changes from 2 commits
Commits
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
25 changes: 25 additions & 0 deletions _overviews/scala3-scaladoc/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,29 @@ 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`.

## Structure

When creating a blog page, you will have a first part to fill in with different fields. See the following example:

```
---
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>
excerpt_separator: <!--more-->
date: <Date of the creation of the page>
authorImg: <Link to the author's image>
---
<Content>
```

## Special characters for the content

` ```<content>``` ` : For code

`## Subtitle` : For subtitles

`word` : To highlight

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