2.1 KiB
| title | date | summary | description | toc | readTime | autonumber | math | showTags |
|---|---|---|---|---|---|---|---|---|
| Single Page Parameters | 2024-10-09 | Single Page Parameters parameters | Single Page Parameters parameters | false | false | true | false | false |
The following parameters apply to single pages, they are meant to be inserted in the .md files introductions, apart from the date format.
Author
You can specify an author name to display and avatar path to use. Here is an example using an image from /static:
author: "Francesco"
authorAvatarPath: "/avatar.jpeg"
Table of Contents
Show a table of contents at the beginning of the post.
toc: true
Sections Auto-numbering
Auto-number headings.
autonumber: true
Note that headings should start from level two.
Math Rendering
Enable math rendering.
math: true
You may encounter issues rendering complex equations. This is due to a known issue.
A possible workaround is to wrap your equation in rawhtml tags:
<rawhtml>
$$
...
$$
</rawhtml>
You must wrap the rawhtml tag in {{ ... }}, omitted due to rendering constraints.
Tags
Create tags associated with the post and decide to show them.
tags: ["database", "java"]
showTags: false
Display Read Time
Choose to display reading time.
readTime: true
Hide Back to Top
Choose to display back to top at the end of the page.
hideBackToTop: true
Hide Pagination Controls
Choose to display pagination controls at the end of the page.
hidePagination: true
Meta Description
You can specify the post meta description as follows:
description: "Your Description"
Fediverse
You can include a fediverse handle in your posts.
fediverse: "@username@instance.url"
Date Format
You can decide the date format to apply to single posts by setting the following param in the toml file:
[params]
singleDateFormat = '2 January 2006'