Below are variables used with this theme…
Site Variables under Params name type example Description 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 ShowReadingTimeboolean true | false To show read time in post meta ShowShareButtonsboolean true | false To show/hide share buttons under post ShowCodeCopyButtonsboolean true | false To show/hide Code Copy button ShowFullTextinRSSboolean true | false To show Content in RSS feed defaultThemestring light | dark | auto To set default theme disableThemeToggleboolean true | false To disable theme toggle icon shown besides label disableSpecial1stPostboolean true | false To disable no-card special appearance of 1st post disableScrollToTopboolean true | false To disable ScrollToTop button disableAnchoredHeadingsboolean true | false To disable Anchored Headings hideMetaboolean true | false To Hide meta elements : date, read-time, author and available-translations for page hideSummaryboolean true | false To Hide summary being shown in list pages showtocboolean true | false To show/hide Table of Contents tocopenboolean true | false To keep open ToC by default on page load ShowPostNavLinksboolean true | false Show Previous and Next Posts below a Post ShowBreadCrumbsboolean true | false Show BreadCrumb Navigation above single post/page commentsboolean true | false To 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
Site Variables name type example Description copyrightstring **[example.site](https://example.site)**This is HUGO’s site variable , which can also render markdown content
label name type example Description 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.iconHeightinteger 35 To set size of label logo image
profileMode name type example Description profileMode.enabledboolean true | false For 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 :
- name : Archive
url : "/archive"
- name : Github
url : "https://github.com/"
copy assets name type example Description assets.faviconstring ‘icon.ico’ To set favicon, can be path or external link assets.disableFingerprintingboolean true | false To disable Sub-Resource integrity for assets
cover name type example Description cover.linkFullImagesboolean true | false To open full size cover images on click on cover cover.responsiveImagesboolean true | false To enable/disable generation of responsive cover images cover.hiddenboolean true | false To hide everywhere but not in structured data cover.hiddenInListboolean true | false To hide on list pages and home cover.hiddenInSingleboolean true | false To hide on list pages and home
schema 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
copy socialIcons socialIcons :
- name : "<platform>"
url : "<link>"
- name : "<platform 2>"
url : "<link2>"
copy editPost editPost :
URL : "https://github.com/<path_to_repo>/content"
Text : "Suggest Changes" # edit text
appendFilePath : true # to append file path to Edit link
copy Note: Same format is being used by Page Variables
Page Variables Name Type Example Description showtocboolean true | false To show/hide Table of Contents tocopenboolean true | false To keep open ToC by default on page load hidemetaboolean true | false To Hide meta elements : date, read-time, author and available-translations for page commentsboolean true | false To show/hide comments descriptionstring ‘description text’ Show Post Description under Title canonicalURLstring “https://canonical.url/to/page" To add canonical URL to posts disableShareboolean true | false To hide/show share icons under a page disableAnchoredHeadingsboolean true | false To disable Anchored Headings searchHiddenboolean true | false Hide page from search hideSummaryboolean true | false To Hide summary being shown in list pages ShowReadingTimeboolean true | false To show read time in post meta ShowBreadCrumbsboolean true | false Show BreadCrumb Navigation above single post/page ShowPostNavLinksboolean true | false Show 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.relativeboolean true | false To use relative path for cover image, used in hugo Page-bundles cover.hiddenboolean true | false To hide on current single page weightinteger 5 To set page order or to pin a post to Top of list
