2.4 KiB
title, date, summary, description, toc, readTime, autonumber, math, showTags
| title | date | summary | description | toc | readTime | autonumber | math | showTags |
|---|---|---|---|---|---|---|---|---|
| Other Parameters | 2024-10-08 | Other Parameters parameters | Other Parameters parameters | false | false | true | false | false |
Miscellaneous settings.
Home Meta Description
You can specify the homepage meta description with the following parameter:
[params]
description = "Your description"
Breadcrumbs
Show breadcrumbs on pages.
Example:
[params.breadcrumbs]
enabled = true
showCurrentPage = true
home = "~"
Set enabled to false if you want to hide breadcrumbs. By default, breadcrumbs are shown.
Set showCurrentPage to false to hide the last crumb, i.e, the current page.
home when set with a non-empty string, uses the latter as the first crumb instead of the string "Home".
Comments
Enable comments on your posts using Giscus.
[params.giscus]
enable = false
repo = "your/repo"
repoid = "id"
category = "category"
categoryid = "categoryId"
mapping = "pathname"
theme = "preferred_color_scheme"
Tip: use preferred_color_scheme theme to have a consistent dark and light appearance.
You can decide to hide the comments section on certain pages, using the following parameter on the page itself:
disableComment: true
Umami
You can include Umami in your website as follows:
[params.umami]
enable = true
websiteId = "unique-website-id"
jsLocation = "http://example.org/umami.js"
Favicons
The following favicons are included in the head of the website:
favicon.icofavicon-16x16.pngfavicon-32x32.pngandroid-chrome-192x192.pngapple-touch-icon.png
You must override the existing one in your static folder.
You can also specify a subdirectory of /static if you prefer using the following param:
[params]
faviconPath = 'your-path'
You can easily generate favicons using this website starting from your image. Here you can see an example of icons overriding default ones.
Mermaid Diagrams
Mermaid diagrams are supported, just follow this reference to use them. You can set Mermaid's light- and dark themes in your config; they switch with your blog's light/dark state. These are the defaults:
[params]
mermaidTheme = "default"
mermaidDarkTheme = "dark"