762 lines
31 KiB
HTML
762 lines
31 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 | HackLiberty Blog</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=/posts/papermod/papermod-variables/>
|
||
<link crossorigin=anonymous href=/assets/css/stylesheet.min.ec8da366ca2fb647537ccb7a8f6fa5b4e9cd3c7a0d3171dd2d3baad1e49c8bfc.css integrity="sha256-7I2jZsovtkdTfMt6j2+ltOnNPHoNMXHdLTuq0eSci/w=" rel="preload stylesheet" as=style>
|
||
<script defer crossorigin=anonymous src=/assets/js/highlight.min.7680afc38aa6b15ddf158a4f3780b7b1f7dde7e91d26f073e6229bb7a0793c92.js integrity="sha256-doCvw4qmsV3fFYpPN4C3sffd5+kdJvBz5iKbt6B5PJI=" onload=hljs.initHighlightingOnLoad()></script>
|
||
<link rel=icon href=/favicon.ico>
|
||
<link rel=icon type=image/png sizes=16x16 href=/favicon-16x16.png>
|
||
<link rel=icon type=image/png sizes=32x32 href=/favicon-32x32.png>
|
||
<link rel=apple-touch-icon href=/apple-touch-icon.png>
|
||
<link rel=mask-icon href=/safari-pinned-tab.svg>
|
||
<meta name=theme-color content="#2e2e33">
|
||
<meta name=msapplication-TileColor content="#2e2e33">
|
||
<noscript>
|
||
<style>#theme-toggle,.top-link{display:none}</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="/posts/papermod/papermod-variables/"><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">
|
||
<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":"Variables | Front Matter","item":"/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 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 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 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 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":"912","inLanguage":"en","datePublished":"2021-01-20T00:00:00Z","dateModified":"2021-01-20T00:00:00Z","author":{"@type":"Person","name":"Aditya Telange"},"mainEntityOfPage":{"@type":"WebPage","@id":"/posts/papermod/papermod-variables/"},"publisher":{"@type":"Organization","name":"HackLiberty Blog","logo":{"@type":"ImageObject","url":"/favicon.ico"}}}</script>
|
||
</head>
|
||
<body class=dark id=top>
|
||
<script>localStorage.getItem("pref-theme")==="light"&&document.body.classList.remove('dark')</script>
|
||
<header class=header>
|
||
<nav class=nav>
|
||
<div class=logo>
|
||
<a href=/ accesskey=h title=" (Alt + H)">
|
||
<img src=/hackliberty.png alt=logo aria-label=logo height=35> </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>
|
||
</span>
|
||
</div>
|
||
<ul id=menu>
|
||
<li>
|
||
<a href=/posts/ title=Posts>
|
||
<span>Posts</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href=/archives/ title=Archive>
|
||
<span>Archive</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href=/search/ title="Search (Alt + /)" accesskey=/>
|
||
<span>Search</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href=/series/ title=Series>
|
||
<span>Series</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href=/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=/>Home</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
|
||
</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>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 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>profileMode</span>:
|
||
<span style=color:#f92672>buttons</span>:
|
||
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>Archive</span>
|
||
<span style=color:#f92672>url</span>: <span style=color:#e6db74>"/archive"</span>
|
||
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>Github</span>
|
||
<span style=color:#f92672>url</span>: <span style=color:#e6db74>"https://github.com/"</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 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>"title"</span>, <span style=color:#e6db74>"permalink"</span>, <span style=color:#e6db74>"summary"</span>, <span style=color:#e6db74>"content"</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>"<platform>"</span>
|
||
<span style=color:#f92672>url</span>: <span style=color:#e6db74>"<link>"</span>
|
||
- <span style=color:#f92672>name</span>: <span style=color:#e6db74>"<platform 2>"</span>
|
||
<span style=color:#f92672>url</span>: <span style=color:#e6db74>"<link2>"</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>"https://github.com/<path_to_repo>/content"</span>
|
||
<span style=color:#f92672>Text</span>: <span style=color:#e6db74>"Suggest Changes"</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>
|
||
<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>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=/tags/papermod/>PaperMod</a></li>
|
||
</ul>
|
||
<nav class=paginav>
|
||
<a class=prev href=/posts/papermod/papermod-icons/>
|
||
<span class=title>« Prev</span>
|
||
<br>
|
||
<span>Icons</span>
|
||
</a>
|
||
<a class=next href=/posts/rich-content/>
|
||
<span class=title>Next »</span>
|
||
<br>
|
||
<span>Rich Content</span>
|
||
</a>
|
||
</nav>
|
||
</footer>
|
||
</article>
|
||
</main>
|
||
<footer class=footer>
|
||
<span>© 2022 <a href=/>HackLiberty Blog</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(a=>{a.addEventListener("click",function(b){b.preventDefault();var a=this.getAttribute("href").substr(1);window.matchMedia('(prefers-reduced-motion: reduce)').matches?document.querySelector(`[id='${decodeURIComponent(a)}']`).scrollIntoView():document.querySelector(`[id='${decodeURIComponent(a)}']`).scrollIntoView({behavior:"smooth"}),a==="top"?history.replaceState(null,null," "):history.pushState(null,null,`#${a}`)})})</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(b=>{const c=b.parentNode.parentNode,a=document.createElement('button');a.classList.add('copy-code'),a.innerHTML='copy';function d(){a.innerHTML='copied!',setTimeout(()=>{a.innerHTML='copy'},2e3)}a.addEventListener('click',e=>{if('clipboard'in navigator){navigator.clipboard.writeText(b.textContent),d();return}const a=document.createRange();a.selectNodeContents(b);const c=window.getSelection();c.removeAllRanges(),c.addRange(a);try{document.execCommand('copy'),d()}catch(a){}c.removeRange(a)}),c.classList.contains("highlight")?c.appendChild(a):c.parentNode.firstChild==c||(b.parentNode.parentNode.parentNode.parentNode.parentNode.nodeName=="TABLE"?b.parentNode.parentNode.parentNode.parentNode.parentNode.appendChild(a):b.parentNode.appendChild(a))})</script>
|
||
</body>
|
||
</html> |