<!doctype html><htmllang=endir=auto><head><metacharset=utf-8><metahttp-equiv=x-ua-compatiblecontent="IE=edge"><metaname=viewportcontent="width=device-width,initial-scale=1,shrink-to-fit=no"><metaname=robotscontent="index, follow"><title>Variables | Front Matter | PaperMod</title><metaname=keywordscontent="PaperMod"><metaname=descriptioncontent="List of Front Matter variables used by PaperMod"><metaname=authorcontent="Aditya Telange"><linkrel=canonicalhref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/><linkhref=/hugo-PaperMod/assets/css/stylesheet.min.d85457619e67d31b97f40ed67c71b5efe0b52508ba759e5a9da0760afd6707db.cssintegrity="sha256-2FRXYZ5n0xuX9A7WfHG17+C1JQi6dZ5anaB2Cv1nB9s="rel="preload stylesheet"as=style><linkrel=iconhref=https://adityatelange.github.io/hugo-PaperMod/favicon.ico><linkrel=icontype=image/pngsizes=16x16href=https://adityatelange.github.io/hugo-PaperMod/favicon-16x16.png><linkrel=icontype=image/pngsizes=32x32href=https://adityatelange.github.io/hugo-PaperMod/favicon-32x32.png><linkrel=apple-touch-iconhref=https://adityatelange.github.io/hugo-PaperMod/apple-touch-icon.png><linkrel=mask-iconhref=https://adityatelange.github.io/hugo-PaperMod/safari-pinned-tab.svg><metaname=theme-colorcontent="#2e2e33"><metaname=msapplication-TileColorcontent="#2e2e33"><metaname=generatorcontent="Hugo 0.82.0"><linkrel=alternatehreflang=enhref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/><metaproperty="og:title"content="Variables | Front Matter"><metaproperty="og:description"content="List of Front Matter variables used by PaperMod"><metaproperty="og:type"content="article"><metaproperty="og:url"content="https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-variables/"><metaproperty="og:image"content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><metaproperty="article:section"content="posts"><metaproperty="article:published_time"content="2021-01-20T00:00:00+00:00"><metaproperty="article:modified_time"content="2021-01-20T00:00:00+00:00"><metaname=twitter:cardcontent="summary_large_image"><metaname=twitter:imagecontent="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><metaname=twitter:titlecontent="Variables | Front Matter"><metaname=twitter:descriptioncontent="List of Front Matter variables used by PaperMod"><scripttype=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><scripttype=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Variables|FrontMatter","name":"Variables|FrontMatter","description":"ListofFrontMattervariablesusedbyPaperMod","keywords":["PaperMod"],"articleBody":"Belowarevariablesusedwiththistheme…\nSiteVariablesunderParamsnametypeexampleDescriptionenvstring‘production’Tosetenvtoproductiontitlestring‘MyBlog’Tosettitledescriptionstring‘Thisisablogofmine’Tosetsitedescriptionauthorstring|list‘Me’|[‘Me’,‘You’]ToshowmultipleAuthorsimagesstring‘myimage.png’Linkorpathofimageforopengraph,twitter-cardsDateFormatstring“January2,2006”Theformatofdatestringsinthewebsite.DetailsShowReadingTimebooleantrue|falseToshowreadtimeinpostmetaShowShareButtonsbooleantrue|falseToshow/hidesharebuttonsunderpostdefaultThemestringlight|dark|autoTosetdefaultthemedisableThemeTogglebooleantrue|falseTodisablethemetoggleiconshownbesideslabeldisableSpecial1stPostbooleantrue|false
<spanclass=logo-switches><buttonid=theme-toggleaccesskey=ttitle="(Alt + T)"><svgid="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"><pathd="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg><svgid="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"><circlecx="12"cy="12"r="5"/><linex1="12"y1="1"x2="12"y2="3"/><linex1="12"y1="21"x2="12"y2="23"/><linex1="4.22"y1="4.22"x2="5.64"y2="5.64"/><linex1="18.36"y1="18.36"x2="19.78"y2="19.78"/><linex1="1"y1="12"x2="3"y2="12"/><linex1="21"y1="12"x2="23"y2="12"/><linex1="4.22"y1="19.78"x2="5.64"y2="18.36"/><linex1="18.36"y1="5.64"x2="19.78"y2="4.22"/></svg></button><ulclass=lang-switch><li>|</li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/fr/title=:fr:aria-label=:fr:>🇫🇷</a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/fa/title=Faaria-label=Fa>Fa</a></li></ul></span></div><ulid=menuonscroll=menu_on_scroll()><li><ahref=https://adityatelange.github.io/hugo-PaperMod/archivestitle=Archive><span>Archive</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/categories/title=Categories><span>Categories</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/search/title="Search (Alt + /)"accesskey=/><span>Search</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/tags/title=Tags><span>Tags</span></a></li></ul></nav></header><mainclass=main><articleclass=post-single><headerclass=post-header><divclass=breadcrumbs><ahref=https://adityatelange.github.io/hugo-PaperMod/>Home</a> » <ahref=https://adityatelange.github.io/hugo-PaperMod/posts/>Posts</a> » <ahref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/>PaperMod</a></div><h1class=post-title>Variables | Front Matter<divclass=entry-isdraft><sup> [draft]</sup></div></h1><divclass=post-meta>January 20, 2021 · 4 min · Aditya Telange</div></header><divclass=toc><details><summaryaccesskey=ctitle="(Alt + C)"><divclass=details>Table of Contents</div></summary><divclass=inner><ul><li><ahref=#site-variables-under-paramsaria-label="Site Variables under Params">Site Variables under <code>Params</code></a><ul><li><ahref=#labelaria-label=label>label</a></li><li><ahref=#profilemodearia-label=profileMode>profileMode</a><ul><li><ahref=#profilemodebuttonsaria-label=profileMode.buttons>profileMode.buttons</a></li></ul></li><li><ahref=#assetsaria-label=assets>assets</a></li><li><ahref=#coveraria-label=cover>cover</a></li><li><ahref=#fuseoptsaria-label=fuseOpts>fuseOpts</a></li><li><ahref=#socialiconsaria-label=socialIcons>socialIcons</a></li><li><ahref=#editpostaria-label=editPost>editPost</a></li></ul></li><li><ahref=#page-variablesaria-label="Page Variables">Page Variables</a></li></ul></div></details></div><divclass=post-content><p><strong>Below are variables used with this theme…</strong></p><hr><h3id=site-variables-under-params>Site Variables under <code>Params</code><ahiddenclass=anchoraria-hidden=truehref=#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 ima
</code></pre></div><h4id=assets>assets<ahiddenclass=anchoraria-hidden=truehref=#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><h4id=cover>cover<ahiddenclass=anchoraria-hidden=truehref=#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><h4id=fuseopts>fuseOpts<ahiddenclass=anchoraria-hidden=truehref=#fuseopts>#</a></h4><p>Refer: <ahref=https://fusejs.io/api/options.html>https://fusejs.io/api/options.html</a></p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>fuseOpts</span>:
<spanstyle=color:#f92672>keys</span>: [<spanstyle=color:#e6db74>"title"</span>, <spanstyle=color:#e6db74>"permalink"</span>, <spanstyle=color:#e6db74>"summary"</span>, <spanstyle=color:#e6db74>"content"</span>] <spanstyle=color:#75715e>## can be less but not more than shown in list</span>
<spanstyle=color:#f92672>appendFilePath</span>: <spanstyle=color:#66d9ef>true</span><spanstyle=color:#75715e># to append file path to Edit link</span>
</code></pre></div><blockquote><p>Note: Same format is being used by Page Variables</p></blockquote><hr><h3id=page-variables>Page Variables<ahiddenclass=anchoraria-hidden=truehref=#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>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>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>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><footerclass=post-footer><ulclass=post-tags><li><ahref=https://adityatelange.github.io/hugo-PaperMod/tags/papermod/>PaperMod</a></li></ul><navclass=paginav><aclass=prevhref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/><spanclass=title>« Prev Page</span><br><span>Icons</span></a>
<span>Theme <ahref=https://git.io/hugopapermodrel=noopenertarget=_blank>PaperMod</a></span></footer><ahref=#toparia-label="go to top"title="Go to Top (Alt + G)"><buttonclass=top-linkid=top-linktype=buttonaccesskey=g><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 12 6"fill="currentcolor"><pathd="M12 6H0l6-6z"/></svg></button></a>
