This commit is contained in:
adityatelange committed 2021-08-14 14:41:55 +00:00
1 parent 903ee79197
commit db0a2c482f
7 files changed
+122 -54

No files matched your search

+45 -12
View File
@@ -30,7 +30,7 @@
<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 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 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 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: Archive url: \"/archive\" - name: Github url: \"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: 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: \"\" url: \"\" - name: \"\" url: \"\" editPost editPost: URL: \"https://github.com//content\" Text: \"Suggest Changes\" # edit text appendFilePath: true # to append file path to Edit link NotLine truncated
<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 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: Archive url: \"/archive\" - name: Github url: \"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: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: [\"title\", \"permalink\", \"summary\", \"content\"] ## can be leLine truncated
</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>
@@ -95,7 +95,9 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
</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><ul>
<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>
@@ -233,6 +235,12 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
<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>
@@ -342,6 +350,25 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
</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&rsquo;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>
@@ -543,13 +570,13 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
<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 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-yml data-lang=yml><span style=color:#f92672>fuseOpts</span>:
<span style=color:#f92672>isCaseSensitive</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>shouldSort</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>location</span>: <span style=color:#ae81ff>0</span>
<span style=color:#f92672>distance</span>: <span style=color:#ae81ff>1000</span>
<span style=color:#f92672>threshold</span>: <span style=color:#ae81ff>0.4</span>
<span style=color:#f92672>minMatchCharLength</span>: <span style=color:#ae81ff>0</span>
<span style=color:#f92672>keys</span>: [<span style=color:#e6db74>&#34;title&#34;</span>, <span style=color:#e6db74>&#34;permalink&#34;</span>, <span style=color:#e6db74>&#34;summary&#34;</span>, <span style=color:#e6db74>&#34;content&#34;</span>] <span style=color:#75715e>## can be less but not more than shown in list</span>
<span style=color:#f92672>isCaseSensitive</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>shouldSort</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>location</span>: <span style=color:#ae81ff>0</span>
<span style=color:#f92672>distance</span>: <span style=color:#ae81ff>1000</span>
<span style=color:#f92672>threshold</span>: <span style=color:#ae81ff>0.4</span>
<span style=color:#f92672>minMatchCharLength</span>: <span style=color:#ae81ff>0</span>
<span style=color:#f92672>keys</span>: [<span style=color:#e6db74>&#34;title&#34;</span>, <span style=color:#e6db74>&#34;permalink&#34;</span>, <span style=color:#e6db74>&#34;summary&#34;</span>, <span style=color:#e6db74>&#34;content&#34;</span>] <span style=color:#75715e>## can be less but not more than shown in list</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 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-yml data-lang=yml><span style=color:#f92672>socialIcons</span>:
- <span style=color:#f92672>name</span>: <span style=color:#e6db74>&#34;&lt;platform&gt;&#34;</span>
@@ -558,9 +585,9 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;&lt;link2&gt;&#34;</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 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-yml data-lang=yml><span style=color:#f92672>editPost</span>:
<span style=color:#f92672>URL</span>: <span style=color:#e6db74>&#34;https://github.com/&lt;path_to_repo&gt;/content&#34;</span>
<span style=color:#f92672>Text</span>: <span style=color:#e6db74>&#34;Suggest Changes&#34;</span> <span style=color:#75715e># edit text</span>
<span style=color:#f92672>appendFilePath</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># to append file path to Edit link</span>
<span style=color:#f92672>URL</span>: <span style=color:#e6db74>&#34;https://github.com/&lt;path_to_repo&gt;/content&#34;</span>
<span style=color:#f92672>Text</span>: <span style=color:#e6db74>&#34;Suggest Changes&#34;</span> <span style=color:#75715e># edit text</span>
<span style=color:#f92672>appendFilePath</span>: <span style=color:#66d9ef>true</span> <span style=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>
@@ -625,6 +652,12 @@ Variables | Front Matter<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup><
<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>