mirrors/hugo-typo
1
0
Fork 0
mirror of https://github.com/tomfran/typo.git synced 2025-04-25 13:09:54 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-typo/wiki/features/other-parameters.md
Sangeeth Sudheer 5bbe13fd43
Add breadcrumbs config to hide current page and change home text 
Changes `breadcrumbs` config into an object to add customizations such as hiding current page and changing the text of
the home crumb.

By default, Typo will now show breadcrumbs. If breadcrumbs are enabled, the current default of showing the
current page crumb is preserved.

BREAKING CHANGE: `breadcrumbs` is now an object so existing `breadcrumbs = <true/false>` line in config needs to be changed.
2025-03-09 01:50:55 +05:30

2.4 KiB
Raw Blame History

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.ico
  • favicon-16x16.png
  • 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, 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"