Frontmatter
Written on
Updated on
---
title: Frontmatter
description: About frontmatter
date: 2025-04-17
lastmod: 2025-04-26
tags: sample frontmatter blog
draft: true
pin: 1
banner: image.png
---
| Required | Default vaule | Type | |
|---|---|---|---|
| title | O | New post yyyy-mm-dd |
String |
| description | o | . | String |
| date | O | yyyy-mm-dd |
yyyy-mm-dd |
| lastmod | X | . | yyyy-mm-dd |
| tags | X | . | String |
| draft | X | false |
bool |
| pin | X | . | int |
| banner | X | . | String |
yyyy-mm-dd is the date format
This is a yaml-like syntax.
There must always be a space after the colon(:).
The title and date are required, while the rest are optional. description is useful for the blog frontpage.
date and lastmod must always be written in yyyy-mm-dd format.
tags are separated by whitespaces. Tags must only use alphabets, numbers, dashes(-), and underscores(_). Duplicate tags will be ignored.
If you want to pin a post, you need to enter a natural number for pin. pin: 1 will be the top pinned post. If you do not want to pin a post, you can either leave it blank or delete the line.
The banner image can use relative paths, absolute paths, or external links.