hugo-theme-wondermod/posts/papermod/papermod-variables/index.html

8 lines
21 KiB
HTML
Raw Normal View History

<!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>Papermod - Variables - 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 href=https://adityatelange.github.io/hugo-PaperMod/assets/css/stylesheet.min.08d6f2005b6ce4ed10207916c0411c66e66f2201e3f7a56e8fb2ccbc4a8b259c.css integrity="sha256-CNbyAFts5O0QIHkWwEEcZuZvIgHj96Vuj7LMvEqLJZw=" rel="preload stylesheet" as=style><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"><meta name=generator content="Hugo 0.78.2"><meta property="og:title" content="Papermod - Variables"><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="article:published_time" content="2020-09-24T11:33:33+05:30"><meta property="article:modified_time" content="2020-09-24T11:33:33+05:30"><meta name=twitter:card content="summary"><meta name=twitter:title content="Papermod - Variables"><meta name=twitter:description content="List of Front Matter variables used by PaperMod"><script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Papermod - Variables","name":"Papermod - Variables","description":"List of Front Matter variables used by PaperMod","keywords":["PaperMod"],"articleBody":"Below are variables used with this theme\n Site Variables 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 [Me,You] list To show multiple Authors images string myimage.png Link or path of image for opengraph, twitter-cards ShowReadingTime boolean true | false To show read time in post meta ShowShareButtons boolean true | false To show/hide share buttons under post 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 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 assets.favicon string icon.ico To set favicon, can be path or external link 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 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 cover.image string featured.jpg To add a cover image cover.caption string caption for image To add caption to cover image cov
<span class=logo-switches><span class=theme-toggle><a id=theme-toggle accesskey=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></a></span><span class=lang-switch><span>|</span><ul><li><a href=https://adityatelange.github.io/hugo-PaperMod/l2/ title=Lang2 aria-label=Lang2>Lang2</a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/l3/ title=Langrtl aria-label=Langrtl>Langrtl</a></li></ul></span></span></div><ul class=menu id=menu onscroll=menu_on_scroll()><li><a href=https://adityatelange.github.io/hugo-PaperMod/archives/><span>Archives</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/tags/><span>Tags</span></a></li></ul></nav></header><main class=main><article class=post-single><header class=post-header><h1 class=post-title>Papermod - Variables<div class=entry-isdraft><sup>&nbsp;&nbsp;[draft]</sup></div></h1><div class=post-meta>September 24, 2020&nbsp;·&nbsp;2 min&nbsp;·&nbsp;Aditya Telange</div></header><div class=toc><details open><summary><div class=details accesskey=c>Table of Contents</div></summary><blockquote><ul><li><a href=#site-variables aria-label="Site Variables">Site Variables</a></li><li><a href=#page-variables aria-label="Page Variables">Page Variables</a></li></ul></blockquote></details></div><div class=post-content><p><strong>Below are variables used with this theme&mldr;</strong></p><hr><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>env</td><td>string</td><td>&lsquo;production&rsquo;</td><td>To set env to production</td></tr><tr><td>title</td><td>string</td><td>&lsquo;My Blog&rsquo;</td><td>To set title</td></tr><tr><td>description</td><td>string</td><td>&lsquo;This is a blog of mine&rsquo;</td><td>To set site description</td></tr><tr><td>author</td><td>[&ldquo;Me&rdquo;,&ldquo;You&rdquo;]</td><td>list</td><td>To show multiple Authors</td></tr><tr><td>images</td><td>string</td><td>&lsquo;myimage.png&rsquo;</td><td>Link or path of image for opengraph, twitter-cards</td></tr><tr><td>ShowReadingTime</td><td>boolean</td><td>true | false</td><td>To show read time in post meta</td></tr><tr><td>ShowShareButtons</td><td>boolean</td><td>true | false</td><td>To show/hide share buttons under post</td></tr><tr><td>defaultTheme</td><td>string</td><td>light | dark | auto</td><td>To set default theme</td></tr><tr><td>disableThemeToggle</td><td>boolean</td><td>true | false</td><td>To disable theme toggle icon shown besides label</td></tr><tr><td>disableSpecial1stPost</td><td>boolean</td><td>true | false</td><td>To disable no-card special appearance of 1st post</td></tr><tr><td></td><td></td><td></td><td></td></tr><tr><td>label.text</td><td>string</td><td>&lsquo;Home&rsquo;</td><td>To display different label text other than title</td></tr><tr><td>label.icon</td><td>string</td><td>&lsquo;/apple-touch-icon.png&rsquo;</td><td>To display a logo image in label</td></tr><tr><td>label.iconHeight</td><td>integer</td><td>35</td><td>To set size of label logo image</td></tr><tr><td>assets.favicon</td><td>string</td><td>&lsquo;icon.ico&rsquo;</td><td>To set favicon, can be path or external link</td></tr><tr><td>cover.linkFullImages</td><td>boolean</td><td>true |
<span>&#183;</span>
<span>Powered by <a href=https://gohugo.io/ rel="noopener noreferrer" target=_blank>Hugo</a></span>
<span>&#183;</span>
<span>Theme <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" accesskey=g><button class=top-link id=top-link type=button><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 12 6"><path d="M12 6H0l6-6z"/></svg></button></a>
<script defer src=https://adityatelange.github.io/hugo-PaperMod/assets/js/highlight.min.e7afc2928c0925d65c4732dfebe147014d91299a98e819e4b42f25c4fa68e91c.js integrity="sha256-56/CkowJJdZcRzLf6+FHAU2RKZqY6BnktC8lxPpo6Rw=" onload=hljs.initHighlightingOnLoad();></script><script>window.onload=function(){if(localStorage.getItem("menu-scroll-position")){document.getElementById('menu').scrollLeft=localStorage.getItem("menu-scroll-position");}}
document.querySelectorAll('a[href^="#"]').forEach(anchor=>{anchor.addEventListener("click",function(e){e.preventDefault();var id=this.getAttribute("href").substr(1);document.querySelector(`[id='${decodeURIComponent(id)}']`).scrollIntoView({behavior:"smooth"});});});var mybutton=document.getElementById("top-link");window.onscroll=function(){if(document.body.scrollTop>800||document.documentElement.scrollTop>800){mybutton.style.visibility="visible";mybutton.style.opacity="1";}else{mybutton.style.visibility="hidden";mybutton.style.opacity="0";}};function menu_on_scroll(){localStorage.setItem("menu-scroll-position",document.getElementById('menu').scrollLeft);}</script><script>document.getElementById("theme-toggle").addEventListener("click",()=>{if(document.body.className.includes("dark")){document.body.classList.remove('dark');localStorage.setItem("pref-theme",'light');}else{document.body.classList.add('dark');localStorage.setItem("pref-theme",'dark');}})</script></body></html>