Skip to content

Front Matter

Front-matter is the section at the top of a Markdown file, separated by ---, used to specify special values for a page.

markdown
---
title:
date:
type:
comment:
cover:
katex:
reprint:
locate:
---
PropertyValue TypeExplanation
titlestringRequired Page title
datedatetimeRequired Page creation date
typestringRequired Configuration needed for About, Links, Moments, Instant, Toolbox pages
updateddatetimeOptional Page update date
descstringOptional Page description
asidebooleanOptional Enable sidebar (default true)
commentbooleanOptional Show page comment module (default true)
coverstringOptional URL of the top image of the page
reprintbooleanOptional Copyright (default is original) set to true for reprint
katexbooleanOptional Show katex (default false)
locatestringOptional Location of article
leftendstringOptional Text on the bottom left of the banner
rightendstringOptional Text on the bottom right of the banner
rightbtnstringOptional Text on the button on the bottom right of the banner
rightbtnlinkstringOptional Link to be opened when the button on the bottom right of the banner is clicked
containerbooleanOptional Enable container (default true)

Warning

If marking optional parameters, you can add them according to your needs, and you don't need to write them all in the Markdown.

Custom page with a banner image

markdown
---
title: Test
type: banner
container: true
---

Note

If you only need a regular banner effect, you can omit the container property.