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:
---
Property | Value Type | Explanation |
---|---|---|
title | string | Required Page title |
date | datetime | Required Page creation date |
type | string | Required Configuration needed for About, Links, Moments, Instant, Toolbox pages |
updated | datetime | Optional Page update date |
desc | string | Optional Page description |
aside | boolean | Optional Enable sidebar (default true) |
comment | boolean | Optional Show page comment module (default true) |
cover | string | Optional URL of the top image of the page |
reprint | boolean | Optional Copyright (default is original) set to true for reprint |
katex | boolean | Optional Show katex (default false) |
locate | string | Optional Location of article |
leftend | string | Optional Text on the bottom left of the banner |
rightend | string | Optional Text on the bottom right of the banner |
rightbtn | string | Optional Text on the button on the bottom right of the banner |
rightbtnlink | string | Optional Link to be opened when the button on the bottom right of the banner is clicked |
container | boolean | Optional 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.