Below are variables used with this theme…

Site Variables under Params

nametypeexampleDescription
envstring‘production’To set env to production
titlestring‘My Blog’To set title
descriptionstring‘This is a blog of mine’To set site description
authorstring |list‘Me’ | [‘Me’,‘You’]To show multiple Authors
imagesstring‘myimage.png’Link or path of image for opengraph, twitter-cards
keywordslist[blog, page]Add keywords for Home page
DateFormatstring“January 2, 2006”The format of date strings in the website. Details
languageAltTitlestring“English”Alternate title in Multilingual Mode
ShowReadingTimebooleantrue | falseTo show read time in post meta
ShowShareButtonsbooleantrue | falseTo show/hide share buttons under post
ShowCodeCopyButtonsbooleantrue | falseTo show/hide Code Copy button
ShowFullTextinRSSbooleantrue | falseTo show Content in RSS feed
defaultThemestringlight | dark | autoTo set default theme
disableThemeTogglebooleantrue | falseTo disable theme toggle icon shown besides label
disableSpecial1stPostbooleantrue | falseTo disable no-card special appearance of 1st post
disableScrollToTopbooleantrue | falseTo disable ScrollToTop button
hideMetabooleantrue | falseTo Hide meta elements : date, read-time, author and available-translations for page
hideSummarybooleantrue | falseTo Hide summary being shown in list pages
showtocbooleantrue | falseTo show/hide Table of Contents
tocopenbooleantrue | falseTo keep open ToC by default on page load
ShowPostNavLinksbooleantrue | falseShow Previous and Next Posts below a Post
ShowBreadCrumbsbooleantrue | falseShow BreadCrumb Navigation above single post/page
commentsbooleantrue | falseTo show/hide comments
analytics.google.SiteVerificationTagstring“XYZabc”Site Verification Tag for Google Analytics
analytics.bing.SiteVerificationTagstring“XYZabc”Site Verification Tag for Bing
analytics.yandex.SiteVerificationTagstring“XYZabc”Site Verification Tag for Yandex
schema--Details
fuseOpts--Details
socialIcons--Details
label--Details
assets--Details
cover--Details
profileMode--Details
editPost--Details

label

nametypeexampleDescription
label.textstring‘Home’To display different label text other than title
label.iconstring‘/apple-touch-icon.png’To display a logo image in label
label.iconHeightinteger35To set size of label logo image

profileMode

nametypeexampleDescription
profileMode.enabledbooleantrue | falseFor enabling profileMode, needs to be explicitly set
profileMode.titlestring“Title”Title
profileMode.subtitlestring“subtitle here”Subtitle
profileMode.imageUrlstring“image.png” | “https://example.com/image.jpg"Image URL or Link
profileMode.imageWidthstring“150”Width of image
profileMode.imageHeightstring“150”Height of image
profileMode.imageTitlestring“This image is a picture of ..”Title of image
profileMode.buttons--Details
profileMode.buttons
profileMode:
    buttons:
        - name: Archive
        url: "/archive"
        - name: Github
        url: "https://github.com/"

assets

nametypeexampleDescription
assets.faviconstring‘icon.ico’To set favicon, can be path or external link
assets.disableHLJSbooleantrue | falseTo disable Highlight.js loading
assets.disableFingerprintingbooleantrue | falseTo disable Sub-Resource integrity for assets

cover

nametypeexampleDescription
cover.linkFullImagesbooleantrue | falseTo open full size cover images on click on cover
cover.responsiveImagesbooleantrue | falseTo enable/disable generation of responsive cover images
cover.hiddenbooleantrue | falseTo hide everywhere but not in structured data
cover.hiddenInListbooleantrue | falseTo hide on list pages and home
cover.hiddenInSinglebooleantrue | falseTo hide on list pages and home

schema

nametypeexampleDescription
schema.publisherTypestring‘Organization’https://schema.org/publisher
schema.sameAslist[“URL1”, “URL2”]Set https://schema.org/sameAs

fuseOpts

Refer: https://fusejs.io/api/options.html

fuseOpts:
    isCaseSensitive: false
    shouldSort: true
    location: 0
    distance: 1000
    threshold: 0.4
    minMatchCharLength: 0
    keys: ["title", "permalink", "summary", "content"] ##  can be less but not more than shown in list

socialIcons

socialIcons:
    - name: "<platform>"
        url: "<link>"
    - name: "<platform 2>"
        url: "<link2>"

editPost

editPost:
    URL: "https://github.com/<path_to_repo>/content"
    Text: "Suggest Changes" # edit text
    appendFilePath: true # to append file path to Edit link

Note: Same format is being used by Page Variables

Page Variables

NameTypeExampleDescription
showtocbooleantrue | falseTo show/hide Table of Contents
tocopenbooleantrue | falseTo keep open ToC by default on page load
hidemetabooleantrue | falseTo Hide meta elements : date, read-time, author and available-translations for page
commentsbooleantrue | falseTo show/hide comments
descriptionstring‘description text’Show Post Description under Title
canonicalURLstring“https://canonical.url/to/page"To add canonical URL to posts
disableSharebooleantrue | falseTo hide/show share icons under a page
disableHLJSbooleantrue | falseTo disable Highlight.js loading
searchHiddenbooleantrue | falseHide page from search
hideSummarybooleantrue | falseTo Hide summary being shown in list pages
ShowReadingTimebooleantrue | falseTo show read time in post meta
ShowBreadCrumbsbooleantrue | falseShow BreadCrumb Navigation above single post/page
ShowPostNavLinksbooleantrue | falseShow Previous and Next Posts below a Post
authorstring |list‘Me’ | [‘Me’,‘You’]To show multiple Authors
cover.imagestring‘featured.jpg’To add a cover image
cover.captionstring‘caption for image’To add caption to cover image
cover.altstring‘this is cover image’Alternate text to show if image doesn’t load/show up
cover.relativebooleantrue | falseTo use relative path for cover image, used in hugo Page-bundles
cover.hiddenbooleantrue | falseTo hide on current single page
weightinteger5To set page order or to pin a post to Top of list