Other Parameters

Other Parameters parameters

Miscellaneous settings.

Home Meta Description #

You can specify the homepage meta description with the following parameter:

[params]
description = "Your description"

Show breadcrumbs on pages.

[params]
breadcrumbs = true

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.ico
  • favicon-16xng
  • favicon-32x32.png
  • android-chrome-192x192.png
  • apple-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 by theme, just follow this reference to use them.