Z Themes
params.toml

params.toml

The parameters in this file is used only in the zdoc theme.

Whether you want to use a logo icon in the navigation bar or not.

1

logo = true
Zdoc theme param - logoText

logoText

Logo text appears in the navigation bar.

1

logoText = "Z Themes"
Zdoc theme param - logoText

logoType

  • short: default. Treat the logo as a square.
  • long: Treat the logo as a rectangle.
1

logoType = "short"
Zdoc theme param - logoType

description

Used for Search Engine Optimization(SEO)

1

description = "My Awesome Blog!"

useFaviconGenerator

Whether you want to use favicon-generator or not. See the favicon user guide if you want to set this param to true.

1

useFaviconGenerator = true
Zdoc theme param - useFaviconGenerator

wideViewAsDefault

Set it true when you want a wide page view. If true, TOC or menu sidebar will be folded as default.

1

wideViewAsDefault = true
  • true
    Zdoc theme param - wideViewAsDefault
  • false
    Zdoc theme param - wideViewAsDefault

enableWideBlogSwitch

When true, a viewport-sizing toggle button will appear on a blog post page.

1

enableWideBlogSwitch = true
Zdoc theme param - enableWideBlogSwitch

enableTocSwitch

When true, a toc-visibility toggle button will appear on a blog post page.

1

enableTocSwitch = true
Zdoc theme param - enableTocSwitch

enableSearch

Set to true if you want to enable the search feature.

1

enableSearch = true
Zdoc theme param - enableSearch

enableSearchHighlight

When true, search text will be colorized.

1

enableSearchHighlight = true
Zdoc theme param - enableSearchHighlight

enableLangChange

1

enableLangChange = true
Zdoc theme param - enableLangChange

enableDarkMode

When true, a theming toggle button will appear on the navigation bar.

1

enableDarkMode = true
Zdoc theme param - enableDarkMode

enableBreadcrumb

When false, breadcrumb will disappear on every document page.

1

enableBreadcrumb = true
Zdoc theme param - enableBreadcrumb

enableBlogBreadcrumb

When false, breadcrumb will disappear on every blog post.

1

enableBlogBreadcrumb = true
Zdoc theme param - enableBlogBreadcrumb

enableEditBtn

When true, EDIT THIS PAGE button will appear on a page.

1

enableEditBtn = true
Zdoc theme param - enableEditBtn

enableToc

Hide/Show table of contents(TOC).

1

enableToc = true
Zdoc theme param - enableToc

enableMenu

Hide/Show menu sidebar.

1

enableMenu = true
Zdoc theme param - enableMenu

enableNavbar

Hide/Show navigation bar

1

enableNavbar = true
Zdoc theme param - enableNavbar

enableFooter

Hide/Show footer

1

enableFooter = true
Zdoc theme param - enableFooter

showPoweredBy

Hide/Show poweredBy text in the footer.

1

showPoweredBy = true
Zdoc theme param - showPoweredBy

paginateWindow

Setting it to 1 gives 7 buttons, 2 gives 9, etc. If set 1: [1 … 4 5 6 … 356] [1 2 3 4 5 … 356] etc

1

paginateWindow = 1

taxoPaginate

A number of elements per page on the blog tags page.

1

taxoPaginate = 5

taxoGroupByDate

  • “2006-01”: group by month
  • “2006”: group by year
1

taxoGroupByDate = "2006"

github

Link for the GitHub icon in the navigation bar

enableComment

You can add a comment component to a blog type page. Supported comment services are

  • utterances
What's on this Page