mirror of
https://github.com/Wonderfall/hugo-WonderMod.git
synced 2024-11-26 20:41:37 +01:00
30 lines
44 KiB
HTML
30 lines
44 KiB
HTML
<!doctype html><html lang=en dir=auto><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=robots content="index, follow"><title>Variables | Front Matter | PaperMod</title><meta name=keywords content="PaperMod"><meta name=description content="List of Front Matter variables used by PaperMod"><meta name=author content="Aditya Telange"><link rel=canonical href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/><link crossorigin=anonymous href=/hugo-PaperMod/assets/css/stylesheet.min.ec8da366ca2fb647537ccb7a8f6fa5b4e9cd3c7a0d3171dd2d3baad1e49c8bfc.css integrity="sha256-7I2jZsovtkdTfMt6j2+ltOnNPHoNMXHdLTuq0eSci/w=" rel="preload stylesheet" as=style><script defer crossorigin=anonymous src=/hugo-PaperMod/assets/js/highlight.min.2840b7fccd34145847db71a290569594bdbdb00047097f75d6495d162f5d7dff.js integrity="sha256-KEC3/M00FFhH23GikFaVlL29sABHCX911kldFi9dff8=" onload=hljs.initHighlightingOnLoad()></script>
|
||
<link rel=icon href=https://adityatelange.github.io/hugo-PaperMod/favicon.ico><link rel=icon type=image/png sizes=16x16 href=https://adityatelange.github.io/hugo-PaperMod/favicon-16x16.png><link rel=icon type=image/png sizes=32x32 href=https://adityatelange.github.io/hugo-PaperMod/favicon-32x32.png><link rel=apple-touch-icon href=https://adityatelange.github.io/hugo-PaperMod/apple-touch-icon.png><link rel=mask-icon href=https://adityatelange.github.io/hugo-PaperMod/safari-pinned-tab.svg><meta name=theme-color content="#2e2e33"><meta name=msapplication-TileColor content="#2e2e33"><link rel=alternate hreflang=en href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/><noscript><style>#theme-toggle,.top-link{display:none}</style><style>@media(prefers-color-scheme:dark){:root{--theme:rgb(29, 30, 32);--entry:rgb(46, 46, 51);--primary:rgb(218, 218, 219);--secondary:rgb(155, 156, 157);--tertiary:rgb(65, 66, 68);--content:rgb(196, 196, 197);--hljs-bg:rgb(46, 46, 51);--code-bg:rgb(55, 56, 62);--border:rgb(51, 51, 51)}.list{background:var(--theme)}.list:not(.dark)::-webkit-scrollbar-track{background:0 0}.list:not(.dark)::-webkit-scrollbar-thumb{border-color:var(--theme)}}</style></noscript><meta property="og:title" content="Variables | Front Matter"><meta property="og:description" content="List of Front Matter variables used by PaperMod"><meta property="og:type" content="article"><meta property="og:url" content="https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/"><meta property="og:image" content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><meta property="article:section" content="posts"><meta property="article:published_time" content="2021-01-20T00:00:00+00:00"><meta property="article:modified_time" content="2021-01-20T00:00:00+00:00"><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><meta name=twitter:title content="Variables | Front Matter"><meta name=twitter:description content="List of Front Matter variables used by PaperMod"><script type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Posts","item":"https://adityatelange.github.io/hugo-PaperMod/posts/"},{"@type":"ListItem","position":2,"name":"PaperMod","item":"https://adityatelange.github.io/hugo-PaperMod/posts/papermod/"},{"@type":"ListItem","position":3,"name":"Variables | Front Matter","item":"https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/"}]}</script><script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Variables | Front Matter","name":"Variables | Front Matter","description":"List of Front Matter variables used by PaperMod","keywords":["PaperMod"],"articleBody":"Below are variables used with this theme…\n Site Variables under Params name type example Description env string ‘production’ To set env to production title string ‘My Blog’ To set title description string ‘This is a blog of mine’ To set site description author string |list ‘Me’ | [‘Me’,‘You’] To show multiple Authors images string ‘myimage.png’ Link or path of image for opengraph, twitter-cards keywords list [blog, page] Add keywords for Home page DateFormat string “January 2, 2006” The format of date strings in the website. Details languageAltTitle string “English” Alternate title in Multilingual Mode ShowReadingTime boolean true | false To show read time in post meta ShowShareButtons boolean true | false To show/hide share buttons under post ShowCodeCopyButtons boolean true | false To show/hide Code Copy button ShowRssButtonInSectionTermList boolean true | false To show/hide RSS Copy button in Section and Term list ShowFullTextinRSS boolean true | false To show Content in RSS feed defaultTheme string light | dark | auto To set default theme disableThemeToggle boolean true | false To disable theme toggle icon shown besides label disableSpecial1stPost boolean true | false To disable no-card special appearance of 1st post disableScrollToTop boolean true | false To disable ScrollToTop button disableAnchoredHeadings boolean true | false To disable Anchored Headings hideMeta boolean true | false To Hide meta elements : date, read-time, author and available-translations for page hideSummary boolean true | false To Hide summary being shown in list pages showtoc boolean true | false To show/hide Table of Contents tocopen boolean true | false To keep open ToC by default on page load ShowPostNavLinks boolean true | false Show Previous and Next Posts below a Post ShowBreadCrumbs boolean true | false Show BreadCrumb Navigation above single post/page comments boolean true | false To show/hide comments analytics.google.SiteVerificationTag string “XYZabc” Site Verification Tag for Google Analytics analytics.bing.SiteVerificationTag string “XYZabc” Site Verification Tag for Bing analytics.yandex.SiteVerificationTag string “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 copyright string **[example.site](https://example.site)** This is HUGO’s site variable, which can also render markdown content label name type example Description label.text string ‘Home’ To display different label text other than title label.icon string ‘/apple-touch-icon.png’ To display a logo image in label label.iconHeight integer 35 To set size of label logo image profileMode name type example Description profileMode.enabled boolean true | false For enabling profileMode, needs to be explicitly set profileMode.title string “Title” Title profileMode.subtitle string “subtitle here” Subtitle profileMode.imageUrl string “image.png” | “https://example.com/image.jpg\" Image URL or Link profileMode.imageWidth string “150” Width of image profileMode.imageHeight string “150” Height of image profileMode.imageTitle string “This image is a picture of ..” Title of image profileMode.buttons - - Details profileMode.buttons profileMode:buttons:- name:Archiveurl:\"/archive\"- name:Githuburl:\"https://github.com/\"assets name type example Description assets.favicon string ‘icon.ico’ To set favicon, can be path or external link assets.disableHLJS boolean true | false To disable Highlight.js loading assets.disableFingerprinting boolean true | false To disable Sub-Resource integrity for assets cover name type example Description cover.linkFullImages boolean true | false To open full size cover images on click on cover cover.responsiveImages boolean true | false To enable/disable generation of responsive cover images cover.hidden boolean true | false To hide everywhere but not in structured data cover.hiddenInList boolean true | false To hide on list pages and home cover.hiddenInSingle boolean true | false To hide on list pages and home schema name type example Description schema.publisherType string ‘Organization’ https://schema.org/publisher schema.sameAs list [“URL1”, “URL2”] Set https://schema.org/sameAs fuseOpts Refer: https://fusejs.io/api/options.html\nfuseOpts:isCaseSensitive:falseshouldSort:truelocation:0distance:1000threshold:0.4minMatchCharLength:0keys:[\"title\",\"permalink\",\"summary\",\"content\"]## can be less but not more than shown in listsocialIcons socialIcons:- name:\"\"url:\"\"- name:\"\"url:\"\"editPost editPost:URL:\"https://github.com//content\"Text:\"Suggest Changes\"# edit textappendFilePath:true# to append file path to Edit link Note: Same format is being used by Page Variables\n Page Variables Name Type Example Description showtoc boolean true | false To show/hide Table of Contents tocopen boolean true | false To keep open ToC by default on page load hidemeta boolean true | false To Hide meta elements : date, read-time, author and available-translations for page comments boolean true | false To show/hide comments description string ‘description text’ Show Post Description under Title canonicalURL string “https://canonical.url/to/page\" To add canonical URL to posts disableShare boolean true | false To hide/show share icons under a page disableHLJS boolean true | false To disable Highlight.js loading disableAnchoredHeadings boolean true | false To disable Anchored Headings searchHidden boolean true | false Hide page from search hideSummary boolean true | false To Hide summary being shown in list pages ShowReadingTime boolean true | false To show read time in post meta ShowBreadCrumbs boolean true | false Show BreadCrumb Navigation above single post/page ShowPostNavLinks boolean true | false Show Previous and Next Posts below a Post ShowRssButtonInSectionTermList boolean true | false To show/hide RSS Copy button in Section and Term list author string |list ‘Me’ | [‘Me’,‘You’] To show multiple Authors cover.image string ‘featured.jpg’ To add a cover image cover.caption string ‘caption for image’ To add caption to cover image cover.alt string ’this is cover image’ Alternate text to show if image doesn’t load/show up cover.relative boolean true | false To use relative path for cover image, used in hugo Page-bundles cover.hidden boolean true | false To hide on current single page weight integer 5 To set page order or to pin a post to Top of list ","wordCount":"896","inLanguage":"en","datePublished":"2021-01-20T00:00:00Z","dateModified":"2021-01-20T00:00:00Z","author":{"@type":"Person","name":"Aditya Telange"},"mainEntityOfPage":{"@type":"WebPage","@id":"https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/"},"publisher":{"@type":"Organization","name":"PaperMod","logo":{"@type":"ImageObject","url":"https://adityatelange.github.io/hugo-PaperMod/favicon.ico"}}}</script></head><body id=top><script>localStorage.getItem("pref-theme")==="dark"?document.body.classList.add("dark"):localStorage.getItem("pref-theme")==="light"?document.body.classList.remove("dark"):window.matchMedia("(prefers-color-scheme: dark)").matches&&document.body.classList.add("dark")</script><header class=header><nav class=nav><div class=logo><a href=https://adityatelange.github.io/hugo-PaperMod/ accesskey=h title="PaperMod (Alt + H)">PaperMod</a>
|
||
<span class=logo-switches><button id=theme-toggle accesskey=t title="(Alt + T)"><svg id="moon" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg><svg id="sun" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></button><ul class=lang-switch><li>|</li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fr/ title=French aria-label=:fr:>🇫🇷</a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fa/ title=Fa aria-label=Fa>Fa</a></li></ul></span></div><ul id=menu><li><a href=https://adityatelange.github.io/hugo-PaperMod/archives title=Archive><span>Archive</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/categories/ title=Categories><span>Categories</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/search/ title="Search (Alt + /)" accesskey=/><span>Search</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/tags/ title=Tags><span>Tags</span></a></li></ul></nav></header><main class=main><article class=post-single><header class=post-header><div class=breadcrumbs><a href=https://adityatelange.github.io/hugo-PaperMod/>Home</a> » <a href=https://adityatelange.github.io/hugo-PaperMod/posts/>Posts</a> » <a href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/>PaperMod</a></div><h1 class=post-title>Variables | Front Matter<sup><span class=entry-isdraft> [draft]</span></sup></h1><div class=post-meta><span title="2021-01-20 00:00:00 +0000 UTC">January 20, 2021</span> · 5 min · Aditya Telange | <a href=https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/content/posts/papermod/papermod-variables.md rel="noopener noreferrer" target=_blank>Suggest Changes</a></div></header><div class=toc><details><summary accesskey=c title="(Alt + C)"><span class=details>Table of Contents</span></summary><div class=inner><ul><li><a href=#site-variables-under-params aria-label="Site Variables under Params">Site Variables under <code>Params</code></a></li><li><a href=#site-variables aria-label="Site Variables">Site Variables</a><ul><li><a href=#label aria-label=label>label</a></li><li><a href=#profilemode aria-label=profileMode>profileMode</a><ul><li><a href=#profilemodebuttons aria-label=profileMode.buttons>profileMode.buttons</a></li></ul></li><li><a href=#assets aria-label=assets>assets</a></li><li><a href=#cover aria-label=cover>cover</a></li><li><a href=#schema aria-label=schema>schema</a></li><li><a href=#fuseopts aria-label=fuseOpts>fuseOpts</a></li><li><a href=#socialicons aria-label=socialIcons>socialIcons</a></li><li><a href=#editpost aria-label=editPost>editPost</a></li></ul></li><li><a href=#page-variables aria-label="Page Variables">Page Variables</a></li></ul></div></details></div><div class=post-content><p><strong>Below are variables used with this theme…</strong></p><hr><h3 id=site-variables-under-params>Site Variables under <code>Params</code><a hidden class=anchor aria-hidden=true href=#site-variables-under-params>#</a></h3><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>env</code></td><td>string</td><td>‘production’</td><td>To set env to production</td></tr><tr><td><code>title</code></td><td>string</td><td>‘My Blog’</td><td>To set title</td></tr><tr><td><code>description</code></td><td>string</td><td>‘This is a blog of mine’</td><td>To set site description</td></tr><tr><td><code>author</code></td><td>string |list</td><td>‘Me’ | [‘Me’,‘You’]</td><td>To show multiple Authors</td></tr><tr><td><code>images</code></td><td>string</td><td>‘myimage.png’</td><td>Link or path of image for opengraph, twitter-cards</td></tr><tr><td><code>keywords</code></td><td>list</td><td>[blog, page]</td><td>Add keywords for Home page</td></tr><tr><td><code>DateFormat</code></td><td>string</td><td>“January 2, 2006”</td><td>The format of date strings in the website. <a href=https://gohugo.io/functions/format/>Details</a></td></tr><tr><td><code>languageAltTitle</code></td><td>string</td><td>“English”</td><td>Alternate title in Multilingual Mode</td></tr><tr><td><code>ShowReadingTime</code></td><td>boolean</td><td>true | false</td><td>To show read time in post meta</td></tr><tr><td><code>ShowShareButtons</code></td><td>boolean</td><td>true | false</td><td>To show/hide share buttons under post</td></tr><tr><td><code>ShowCodeCopyButtons</code></td><td>boolean</td><td>true | false</td><td>To show/hide Code Copy button</td></tr><tr><td><code>ShowRssButtonInSectionTermList</code></td><td>boolean</td><td>true | false</td><td>To show/hide RSS Copy button in Section and Term list</td></tr><tr><td><code>ShowFullTextinRSS</code></td><td>boolean</td><td>true | false</td><td>To show Content in RSS feed</td></tr><tr><td><code>defaultTheme</code></td><td>string</td><td>light | dark | auto</td><td>To set default theme</td></tr><tr><td><code>disableThemeToggle</code></td><td>boolean</td><td>true | false</td><td>To disable theme toggle icon shown besides label</td></tr><tr><td><code>disableSpecial1stPost</code></td><td>boolean</td><td>true | false</td><td>To disable no-card special appearance of 1st post</td></tr><tr><td><code>disableScrollToTop</code></td><td>boolean</td><td>true | false</td><td>To disable ScrollToTop button</td></tr><tr><td><code>disableAnchoredHeadings</code></td><td>boolean</td><td>true | false</td><td>To disable Anchored Headings</td></tr><tr><td><code>hideMeta</code></td><td>boolean</td><td>true | false</td><td>To Hide meta elements : date, read-time, author and available-translations for page</td></tr><tr><td><code>hideSummary</code></td><td>boolean</td><td>true | false</td><td>To Hide summary being shown in list pages</td></tr><tr><td><code>showtoc</code></td><td>boolean</td><td>true | false</td><td>To show/hide Table of Contents</td></tr><tr><td><code>tocopen</code></td><td>boolean</td><td>true | false</td><td>To keep open ToC by default on page load</td></tr><tr><td><code>ShowPostNavLinks</code></td><td>boolean</td><td>true | false</td><td>Show Previous and Next Posts below a Post</td></tr><tr><td><code>ShowBreadCrumbs</code></td><td>boolean</td><td>true | false</td><td>Show BreadCrumb Navigation above single post/page</td></tr><tr><td><code>comments</code></td><td>boolean</td><td>true | false</td><td>To show/hide comments</td></tr><tr><td><code>analytics.google.SiteVerificationTag</code></td><td>string</td><td>“XYZabc”</td><td>Site Verification Tag for Google Analytics</td></tr><tr><td><code>analytics.bing.SiteVerificationTag</code></td><td>string</td><td>“XYZabc”</td><td>Site Verification Tag for Bing</td></tr><tr><td><code>analytics.yandex.SiteVerificationTag</code></td><td>string</td><td>“XYZabc”</td><td>Site Verification Tag for Yandex</td></tr><tr><td><code>schema</code></td><td>-</td><td>-</td><td><a href=#schema>Details</a></td></tr><tr><td><code>fuseOpts</code></td><td>-</td><td>-</td><td><a href=#fuseOpts>Details</a></td></tr><tr><td><code>socialIcons</code></td><td>-</td><td>-</td><td><a href=#socialIcons>Details</a></td></tr><tr><td><code>label</code></td><td>-</td><td>-</td><td><a href=#label>Details</a></td></tr><tr><td><code>assets</code></td><td>-</td><td>-</td><td><a href=#assets>Details</a></td></tr><tr><td><code>cover</code></td><td>-</td><td>-</td><td><a href=#cover>Details</a></td></tr><tr><td><code>profileMode</code></td><td>-</td><td>-</td><td><a href=#profilemode>Details</a></td></tr><tr><td><code>editPost</code></td><td>-</td><td>-</td><td><a href=#editPost>Details</a></td></tr></tbody></table><h3 id=site-variables>Site Variables<a hidden class=anchor aria-hidden=true href=#site-variables>#</a></h3><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>copyright</code></td><td>string</td><td><code>**[example.site](https://example.site)**</code></td><td>This is <a href=https://gohugo.io/variables/site/#site-variables-list>HUGO’s site variable</a>, which can also render markdown content</td></tr></tbody></table><h4 id=label>label<a hidden class=anchor aria-hidden=true href=#label>#</a></h4><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>label.text</code></td><td>string</td><td>‘Home’</td><td>To display different label text other than title</td></tr><tr><td><code>label.icon</code></td><td>string</td><td>‘/apple-touch-icon.png’</td><td>To display a logo image in label</td></tr><tr><td><code>label.iconHeight</code></td><td>integer</td><td>35</td><td>To set size of label logo image</td></tr></tbody></table><h4 id=profilemode>profileMode<a hidden class=anchor aria-hidden=true href=#profilemode>#</a></h4><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>profileMode.enabled</code></td><td>boolean</td><td>true | false</td><td>For enabling profileMode, needs to be explicitly set</td></tr><tr><td><code>profileMode.title</code></td><td>string</td><td>“Title”</td><td>Title</td></tr><tr><td><code>profileMode.subtitle</code></td><td>string</td><td>“subtitle here”</td><td>Subtitle</td></tr><tr><td><code>profileMode.imageUrl</code></td><td>string</td><td>“image.png” | “<a href=https://example.com/image.jpg%22>https://example.com/image.jpg"</a></td><td>Image URL or Link</td></tr><tr><td><code>profileMode.imageWidth</code></td><td>string</td><td>“150”</td><td>Width of image</td></tr><tr><td><code>profileMode.imageHeight</code></td><td>string</td><td>“150”</td><td>Height of image</td></tr><tr><td><code>profileMode.imageTitle</code></td><td>string</td><td>“This image is a picture of ..”</td><td>Title of image</td></tr><tr><td><code>profileMode.buttons</code></td><td>-</td><td>-</td><td><a href=#profileModebuttons>Details</a></td></tr></tbody></table><h5 id=profilemodebuttons>profileMode.buttons<a hidden class=anchor aria-hidden=true href=#profilemodebuttons>#</a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-yml data-lang=yml><span class=line><span class=cl><span class=nt>profileMode</span><span class=p>:</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>buttons</span><span class=p>:</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span>- <span class=nt>name</span><span class=p>:</span><span class=w> </span><span class=l>Archive</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>url</span><span class=p>:</span><span class=w> </span><span class=s2>"/archive"</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span>- <span class=nt>name</span><span class=p>:</span><span class=w> </span><span class=l>Github</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>url</span><span class=p>:</span><span class=w> </span><span class=s2>"https://github.com/"</span><span class=w>
|
||
</span></span></span></code></pre></div><h4 id=assets>assets<a hidden class=anchor aria-hidden=true href=#assets>#</a></h4><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>assets.favicon</code></td><td>string</td><td>‘icon.ico’</td><td>To set favicon, can be path or external link</td></tr><tr><td><code>assets.disableHLJS</code></td><td>boolean</td><td>true | false</td><td>To disable Highlight.js loading</td></tr><tr><td><code>assets.disableFingerprinting</code></td><td>boolean</td><td>true | false</td><td>To disable Sub-Resource integrity for assets</td></tr></tbody></table><h4 id=cover>cover<a hidden class=anchor aria-hidden=true href=#cover>#</a></h4><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>cover.linkFullImages</code></td><td>boolean</td><td>true | false</td><td>To open full size cover images on click on cover</td></tr><tr><td><code>cover.responsiveImages</code></td><td>boolean</td><td>true | false</td><td>To enable/disable generation of responsive cover images</td></tr><tr><td><code>cover.hidden</code></td><td>boolean</td><td>true | false</td><td>To hide everywhere but not in structured data</td></tr><tr><td><code>cover.hiddenInList</code></td><td>boolean</td><td>true | false</td><td>To hide on list pages and home</td></tr><tr><td><code>cover.hiddenInSingle</code></td><td>boolean</td><td>true | false</td><td>To hide on list pages and home</td></tr></tbody></table><h4 id=schema>schema<a hidden class=anchor aria-hidden=true href=#schema>#</a></h4><table><thead><tr><th>name</th><th>type</th><th>example</th><th>Description</th></tr></thead><tbody><tr><td><code>schema.publisherType</code></td><td>string</td><td>‘Organization’</td><td><a href=https://schema.org/publisher>https://schema.org/publisher</a></td></tr><tr><td><code>schema.sameAs</code></td><td>list</td><td>[“URL1”, “URL2”]</td><td>Set <a href=https://schema.org/sameAs>https://schema.org/sameAs</a></td></tr></tbody></table><h4 id=fuseopts>fuseOpts<a hidden class=anchor aria-hidden=true href=#fuseopts>#</a></h4><p>Refer: <a href=https://fusejs.io/api/options.html>https://fusejs.io/api/options.html</a></p><div class=highlight><pre tabindex=0 class=chroma><code class=language-yml data-lang=yml><span class=line><span class=cl><span class=nt>fuseOpts</span><span class=p>:</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>isCaseSensitive</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>shouldSort</span><span class=p>:</span><span class=w> </span><span class=kc>true</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>location</span><span class=p>:</span><span class=w> </span><span class=m>0</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>distance</span><span class=p>:</span><span class=w> </span><span class=m>1000</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>threshold</span><span class=p>:</span><span class=w> </span><span class=m>0.4</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>minMatchCharLength</span><span class=p>:</span><span class=w> </span><span class=m>0</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>keys</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=s2>"title"</span><span class=p>,</span><span class=w> </span><span class=s2>"permalink"</span><span class=p>,</span><span class=w> </span><span class=s2>"summary"</span><span class=p>,</span><span class=w> </span><span class=s2>"content"</span><span class=p>]</span><span class=w> </span><span class=c>## can be less but not more than shown in list</span><span class=w>
|
||
</span></span></span></code></pre></div><h4 id=socialicons>socialIcons<a hidden class=anchor aria-hidden=true href=#socialicons>#</a></h4><div class=highlight><pre tabindex=0 class=chroma><code class=language-yml data-lang=yml><span class=line><span class=cl><span class=nt>socialIcons</span><span class=p>:</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span>- <span class=nt>name</span><span class=p>:</span><span class=w> </span><span class=s2>"<platform>"</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>url</span><span class=p>:</span><span class=w> </span><span class=s2>"<link>"</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span>- <span class=nt>name</span><span class=p>:</span><span class=w> </span><span class=s2>"<platform 2>"</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>url</span><span class=p>:</span><span class=w> </span><span class=s2>"<link2>"</span><span class=w>
|
||
</span></span></span></code></pre></div><h4 id=editpost>editPost<a hidden class=anchor aria-hidden=true href=#editpost>#</a></h4><div class=highlight><pre tabindex=0 class=chroma><code class=language-yml data-lang=yml><span class=line><span class=cl><span class=nt>editPost</span><span class=p>:</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>URL</span><span class=p>:</span><span class=w> </span><span class=s2>"https://github.com/<path_to_repo>/content"</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>Text</span><span class=p>:</span><span class=w> </span><span class=s2>"Suggest Changes"</span><span class=w> </span><span class=c># edit text</span><span class=w>
|
||
</span></span></span><span class=line><span class=cl><span class=w> </span><span class=nt>appendFilePath</span><span class=p>:</span><span class=w> </span><span class=kc>true</span><span class=w> </span><span class=c># to append file path to Edit link</span><span class=w>
|
||
</span></span></span></code></pre></div><blockquote><p>Note: Same format is being used by Page Variables</p></blockquote><hr><h3 id=page-variables>Page Variables<a hidden class=anchor aria-hidden=true href=#page-variables>#</a></h3><table><thead><tr><th>Name</th><th>Type</th><th>Example</th><th>Description</th></tr></thead><tbody><tr><td><code>showtoc</code></td><td>boolean</td><td>true | false</td><td>To show/hide Table of Contents</td></tr><tr><td><code>tocopen</code></td><td>boolean</td><td>true | false</td><td>To keep open ToC by default on page load</td></tr><tr><td><code>hidemeta</code></td><td>boolean</td><td>true | false</td><td>To Hide meta elements : date, read-time, author and available-translations for page</td></tr><tr><td><code>comments</code></td><td>boolean</td><td>true | false</td><td>To show/hide comments</td></tr><tr><td><code>description</code></td><td>string</td><td>‘description text’</td><td>Show Post Description under Title</td></tr><tr><td><code>canonicalURL</code></td><td>string</td><td>“<a href=https://canonical.url/to/page%22>https://canonical.url/to/page"</a></td><td>To add canonical URL to posts</td></tr><tr><td><code>disableShare</code></td><td>boolean</td><td>true | false</td><td>To hide/show share icons under a page</td></tr><tr><td><code>disableHLJS</code></td><td>boolean</td><td>true | false</td><td>To disable Highlight.js loading</td></tr><tr><td><code>disableAnchoredHeadings</code></td><td>boolean</td><td>true | false</td><td>To disable Anchored Headings</td></tr><tr><td><code>searchHidden</code></td><td>boolean</td><td>true | false</td><td>Hide page from search</td></tr><tr><td><code>hideSummary</code></td><td>boolean</td><td>true | false</td><td>To Hide summary being shown in list pages</td></tr><tr><td><code>ShowReadingTime</code></td><td>boolean</td><td>true | false</td><td>To show read time in post meta</td></tr><tr><td><code>ShowBreadCrumbs</code></td><td>boolean</td><td>true | false</td><td>Show BreadCrumb Navigation above single post/page</td></tr><tr><td><code>ShowPostNavLinks</code></td><td>boolean</td><td>true | false</td><td>Show Previous and Next Posts below a Post</td></tr><tr><td><code>ShowRssButtonInSectionTermList</code></td><td>boolean</td><td>true | false</td><td>To show/hide RSS Copy button in Section and Term list</td></tr><tr><td><code>author</code></td><td>string |list</td><td>‘Me’ | [‘Me’,‘You’]</td><td>To show multiple Authors</td></tr><tr><td><code>cover.image</code></td><td>string</td><td>‘featured.jpg’</td><td>To add a cover image</td></tr><tr><td><code>cover.caption</code></td><td>string</td><td>‘caption for image’</td><td>To add caption to cover image</td></tr><tr><td><code>cover.alt</code></td><td>string</td><td>’this is cover image’</td><td>Alternate text to show if image doesn’t load/show up</td></tr><tr><td><code>cover.relative</code></td><td>boolean</td><td>true | false</td><td>To use relative path for cover image, used in hugo Page-bundles</td></tr><tr><td><code>cover.hidden</code></td><td>boolean</td><td>true | false</td><td>To hide on current single page</td></tr><tr><td><code>weight</code></td><td>integer</td><td>5</td><td>To set page order or to pin a post to Top of list</td></tr></tbody></table></div><footer class=post-footer><ul class=post-tags><li><a href=https://adityatelange.github.io/hugo-PaperMod/tags/papermod/>PaperMod</a></li></ul><nav class=paginav><a class=prev href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/><span class=title>« Prev Page</span><br><span>Icons</span></a>
|
||
<a class=next href=https://adityatelange.github.io/hugo-PaperMod/posts/markdown-syntax/><span class=title>Next Page »</span><br><span>Markdown Syntax Guide</span></a></nav><div class=share-buttons><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on twitter" href="https://twitter.com/intent/tweet/?text=Variables%20%7c%20Front%20Matter&url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f&hashtags=PaperMod"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512H62.554c-34.524.0-62.554-28.03-62.554-62.554V62.554c0-34.524 28.029-62.554 62.554-62.554h386.892zM195.519 424.544c135.939.0 210.268-112.643 210.268-210.268.0-3.218.0-6.437-.153-9.502 14.406-10.421 26.973-23.448 36.935-38.314-13.18 5.824-27.433 9.809-42.452 11.648 15.326-9.196 26.973-23.602 32.49-40.92-14.252 8.429-30.038 14.56-46.896 17.931-13.487-14.406-32.644-23.295-53.946-23.295-40.767.0-73.87 33.104-73.87 73.87.0 5.824.613 11.494 1.992 16.858-61.456-3.065-115.862-32.49-152.337-77.241-6.284 10.881-9.962 23.601-9.962 37.088.0 25.594 13.027 48.276 32.95 61.456-12.107-.307-23.448-3.678-33.41-9.196v.92c0 35.862 25.441 65.594 59.311 72.49-6.13 1.686-12.72 2.606-19.464 2.606-4.751.0-9.348-.46-13.946-1.38 9.349 29.426 36.628 50.728 68.965 51.341-25.287 19.771-57.164 31.571-91.8 31.571-5.977.0-11.801-.306-17.625-1.073 32.337 21.15 71.264 33.41 112.95 33.41z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on linkedin" href="https://www.linkedin.com/shareArticle?mini=true&url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f&title=Variables%20%7c%20Front%20Matter&summary=Variables%20%7c%20Front%20Matter&source=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512H62.554c-34.524.0-62.554-28.03-62.554-62.554V62.554c0-34.524 28.029-62.554 62.554-62.554h386.892zM160.461 423.278V197.561h-75.04v225.717h75.04zm270.539.0V293.839c0-69.333-37.018-101.586-86.381-101.586-39.804.0-57.634 21.891-67.617 37.266v-31.958h-75.021c.995 21.181.0 225.717.0 225.717h75.02V297.222c0-6.748.486-13.492 2.474-18.315 5.414-13.475 17.767-27.434 38.494-27.434 27.135.0 38.007 20.707 38.007 51.037v120.768H431zM123.448 88.722C97.774 88.722 81 105.601 81 127.724c0 21.658 16.264 39.002 41.455 39.002h.484c26.165.0 42.452-17.344 42.452-39.002-.485-22.092-16.241-38.954-41.943-39.002z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on reddit" href="https://reddit.com/submit?url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f&title=Variables%20%7c%20Front%20Matter"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512H62.554c-34.524.0-62.554-28.03-62.554-62.554V62.554c0-34.524 28.029-62.554 62.554-62.554h386.892zM446 265.638c0-22.964-18.616-41.58-41.58-41.58-11.211.0-21.361 4.457-28.841 11.666-28.424-20.508-67.586-33.757-111.204-35.278l18.941-89.121 61.884 13.157c.756 15.734 13.642 28.29 29.56 28.29 16.407.0 29.706-13.299 29.706-29.701.0-16.403-13.299-29.702-29.706-29.702-11.666.0-21.657 6.792-26.515 16.578l-69.105-14.69c-1.922-.418-3.939-.042-5.585 1.036-1.658 1.073-2.811 2.761-3.224 4.686l-21.152 99.438c-44.258 1.228-84.046 14.494-112.837 35.232-7.468-7.164-17.589-11.591-28.757-11.591-22.965.0-41.585 18.616-41.585 41.58.0 16.896 10.095 31.41 24.568 37.918-.639 4.135-.99 8.328-.99 12.576.0 63.977 74.469 115.836 166.33 115.836s166.334-51.859 166.334-115.836c0-4.218-.347-8.387-.977-12.493 14.564-6.47 24.735-21.034 24.735-38.001zM326.526 373.831c-20.27 20.241-59.115 21.816-70.534 21.816-11.428.0-50.277-1.575-70.522-21.82-3.007-3.008-3.007-7.882.0-10.889 3.003-2.999 7.882-3.003 10.885.0 12.777 12.781 40.11 17.317 59.637 17.317 19.522.0 46.86-4.536 59.657-17.321 3.016-2.999 7.886-2.995 10.885.008 3.008 3.011 3.003 7.882-.008 10.889zm-5.23-48.781c-16.373.0-29.701-13.324-29.701-29.698.0-16.381 13.328-29.714 29.701-29.714 16.378.0 29.706 13.333 29.706 29.714.0 16.374-13.328 29.698-29.706 29.698zM160.91 295.348c0-16.381 13.328-29.71 29.714-29.71 16.369.0 29.689 13.329 29.689 29.71.0 16.373-13.32 29.693-29.689 29.693-16.386.0-29.714-13.32-29.714-29.693z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on facebook" href="https://facebook.com/sharer/sharer.php?u=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512H342.978V319.085h66.6l12.672-82.621h-79.272v-53.617c0-22.603 11.073-44.636 46.58-44.636H425.6v-70.34s-32.71-5.582-63.982-5.582c-65.288.0-107.96 39.569-107.96 111.204v62.971h-72.573v82.621h72.573V512h-191.104c-34.524.0-62.554-28.03-62.554-62.554V62.554c0-34.524 28.029-62.554 62.554-62.554h386.892z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on whatsapp" href="https://api.whatsapp.com/send?text=Variables%20%7c%20Front%20Matter%20-%20https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512H62.554c-34.524.0-62.554-28.03-62.554-62.554V62.554c0-34.524 28.029-62.554 62.554-62.554h386.892zm-58.673 127.703c-33.842-33.881-78.847-52.548-126.798-52.568-98.799.0-179.21 80.405-179.249 179.234-.013 31.593 8.241 62.428 23.927 89.612l-25.429 92.884 95.021-24.925c26.181 14.28 55.659 21.807 85.658 21.816h.074c98.789.0 179.206-80.413 179.247-179.243.018-47.895-18.61-92.93-52.451-126.81zM263.976 403.485h-.06c-26.734-.01-52.954-7.193-75.828-20.767l-5.441-3.229-56.386 14.792 15.05-54.977-3.542-5.637c-14.913-23.72-22.791-51.136-22.779-79.287.033-82.142 66.867-148.971 149.046-148.971 39.793.014 77.199 15.531 105.329 43.692 28.128 28.16 43.609 65.592 43.594 105.4-.034 82.149-66.866 148.983-148.983 148.984zm81.721-111.581c-4.479-2.242-26.499-13.075-30.604-14.571-4.105-1.495-7.091-2.241-10.077 2.241-2.986 4.483-11.569 14.572-14.182 17.562-2.612 2.988-5.225 3.364-9.703 1.12-4.479-2.241-18.91-6.97-36.017-22.23C231.8 264.15 222.81 249.484 220.198 245s-.279-6.908 1.963-9.14c2.016-2.007 4.48-5.232 6.719-7.847 2.24-2.615 2.986-4.484 4.479-7.472 1.493-2.99.747-5.604-.374-7.846-1.119-2.241-10.077-24.288-13.809-33.256-3.635-8.733-7.327-7.55-10.077-7.688-2.609-.13-5.598-.158-8.583-.158-2.986.0-7.839 1.121-11.944 5.604-4.105 4.484-15.675 15.32-15.675 37.364.0 22.046 16.048 43.342 18.287 46.332 2.24 2.99 31.582 48.227 76.511 67.627 10.685 4.615 19.028 7.371 25.533 9.434 10.728 3.41 20.492 2.929 28.209 1.775 8.605-1.285 26.499-10.833 30.231-21.295 3.732-10.464 3.732-19.431 2.612-21.298-1.119-1.869-4.105-2.99-8.583-5.232z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Variables | Front Matter on telegram" href="https://telegram.me/share/url?text=Variables%20%7c%20Front%20Matter&url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-variables%2f"><svg viewBox="2 2 28 28"><path d="M26.49 29.86H5.5a3.37 3.37.0 01-2.47-1 3.35 3.35.0 01-1-2.47V5.48A3.36 3.36.0 013 3 3.37 3.37.0 015.5 2h21A3.38 3.38.0 0129 3a3.36 3.36.0 011 2.46V26.37a3.35 3.35.0 01-1 2.47 3.38 3.38.0 01-2.51 1.02zm-5.38-6.71a.79.79.0 00.85-.66L24.73 9.24a.55.55.0 00-.18-.46.62.62.0 00-.41-.17q-.08.0-16.53 6.11a.59.59.0 00-.41.59.57.57.0 00.43.52l4 1.24 1.61 4.83a.62.62.0 00.63.43.56.56.0 00.4-.17L16.54 20l4.09 3A.9.9.0 0021.11 23.15zM13.8 20.71l-1.21-4q8.72-5.55 8.78-5.55c.15.0.23.0.23.16a.18.18.0 010 .06s-2.51 2.3-7.52 6.8z"/></svg></a></div></footer></article></main><footer class=footer><span>© 2022 <a href=https://adityatelange.github.io/hugo-PaperMod/>PaperMod</a></span>
|
||
<span>Powered by
|
||
<a href=https://gohugo.io/ rel="noopener noreferrer" target=_blank>Hugo</a> &
|
||
<a href=https://git.io/hugopapermod rel=noopener target=_blank>PaperMod</a></span></footer><a href=#top aria-label="go to top" title="Go to Top (Alt + G)" class=top-link id=top-link accesskey=g><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 12 6" fill="currentcolor"><path d="M12 6H0l6-6z"/></svg></a><script>let menu=document.getElementById("menu");menu&&(menu.scrollLeft=localStorage.getItem("menu-scroll-position"),menu.onscroll=function(){localStorage.setItem("menu-scroll-position",menu.scrollLeft)}),document.querySelectorAll('a[href^="#"]').forEach(e=>{e.addEventListener("click",function(t){t.preventDefault();var e=this.getAttribute("href").substr(1);window.matchMedia("(prefers-reduced-motion: reduce)").matches?document.querySelector(`[id='${decodeURIComponent(e)}']`).scrollIntoView():document.querySelector(`[id='${decodeURIComponent(e)}']`).scrollIntoView({behavior:"smooth"}),e==="top"?history.replaceState(null,null," "):history.pushState(null,null,`#${e}`)})})</script><script>var mybutton=document.getElementById("top-link");window.onscroll=function(){document.body.scrollTop>800||document.documentElement.scrollTop>800?(mybutton.style.visibility="visible",mybutton.style.opacity="1"):(mybutton.style.visibility="hidden",mybutton.style.opacity="0")}</script><script>document.getElementById("theme-toggle").addEventListener("click",()=>{document.body.className.includes("dark")?(document.body.classList.remove("dark"),localStorage.setItem("pref-theme","light")):(document.body.classList.add("dark"),localStorage.setItem("pref-theme","dark"))})</script><script>document.querySelectorAll("pre > code").forEach(t=>{const n=t.parentNode.parentNode,e=document.createElement("button");e.classList.add("copy-code"),e.innerText="copy";function s(){e.innerText="copied!",setTimeout(()=>{e.innerText="copy"},2e3)}e.addEventListener("click",o=>{if("clipboard"in navigator){navigator.clipboard.writeText(t.textContent),s();return}const e=document.createRange();e.selectNodeContents(t);const n=window.getSelection();n.removeAllRanges(),n.addRange(e);try{document.execCommand("copy"),s()}catch(e){}n.removeRange(e)}),n.classList.contains("highlight")?n.appendChild(e):n.parentNode.firstChild==n||(t.parentNode.parentNode.parentNode.parentNode.parentNode.nodeName=="TABLE"?t.parentNode.parentNode.parentNode.parentNode.parentNode.appendChild(e):t.parentNode.appendChild(e))})</script></body></html> |