blog.hackliberty.org/posts/papermod/papermod-installation/index.html

399 lines
34 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Installation | Update | HackLiberty Blog</title>
<meta name=keywords content="PaperMod">
<meta name=description content="Read Install and Update instructions here">
<meta name=author content="Aditya Telange">
<link rel=canonical href=/posts/papermod/papermod-installation/>
<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="Installation | Update">
<meta property="og:description" content="Read Install and Update instructions here">
<meta property="og:type" content="article">
<meta property="og:url" content="/posts/papermod/papermod-installation/"><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="Installation | Update">
<meta name=twitter:description content="Read Install and Update instructions here">
<script type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Installation | Update","item":"/posts/papermod/papermod-installation/"}]}</script>
<script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Installation | Update","name":"Installation | Update","description":"Read Install and Update instructions here","keywords":["PaperMod"],"articleBody":"Intro Well be using yml/yaml format for all examples down below, I recommend using yml over toml as it is easier to read. You can find any YML to TOML converters if necessary. Guide Follow Quick Start guide to setup hugo and create a new site.\n Note: Use -f to select yml format\nhugo new site -f yml\n Make sure you install latest version of hugo(=0.82.0).\nAfter you have created a new site, at Step 3 follow the steps:\nMethod 1 Inside the folder of your Hugo site, run:\ngit clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1 Note: You may use --branch v5.0 to end of above command if you want to stick to specific release.\n Updating theme :\ncd themes/PaperMod git pull Method 2 you can use as submodule with\ngit submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1 git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically) Note: You may use --branch v5.0 to end of above command if you want to stick to specific release.\n Updating theme :\ngit submodule update --remote --merge Method 3 Or you can Download as Zip from Github Page and extract in your themes directory\nDirect Links:\n Master Branch (Latest) v5.0 v4.0 v3.0 v2.0 v1.0 Finally … Add in config.yml:\ntheme: \"PaperMod\" Quick Links Papermod - Features Papermod - FAQs Papermod - Variables Papermod - Icons ChangeLog Sample config.yml Example Site Structure is present here: exampleSite\n Use appropriately\nbaseURL: \"https://examplesite.com/\" title: ExampleSite paginate: 5 theme: PaperMod enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false googleAnalytics: UA-123-45 minify: disableXML: true minifyOutput: true params: env: production # to enable google analytics, opengraph, twitter-cards and schema. title: ExampleSite description: \"ExampleSite description\" keywords: [Blog, Portfolio, PaperMod] author: Me # author: [\"Me\", \"You\"] # multiple authors images: [\"\"] DateFormat: \"January 2, 2006\" defaultTheme: auto # dark, light disableThemeToggle: false ShowReadingTime: true ShowShareButtons: true ShowPostNavLinks: true ShowBreadCrumbs: true ShowCodeCopyButtons: false disableSpecial1stPost: false disableScrollToTop: false comments: false hidemeta: false hideSummary: false showtoc: false tocopen: false assets: # disableHLJS: true # to disable highlight.js # disableFingerprinting: true favicon: \"\" favicon16x16: \"\" favicon32x32: \"\" apple_touch_icon: \"\" safari_pinned_tab: \"\" label: text: \"Home\" icon: /apple-touch-icon.png iconHeight: 35 # profile-mode profileMode: enabled: false # needs to be explicitly set title: ExampleSite subtitle: \"This is subtitle\" imageUrl: \"\" imageWidth: 120 imageHeight: 120 imageTitle: my image buttons: - name: Posts url: posts - name: Tags url: tags # home-info mode homeInfoParams: Title: \"Hi there \\U0001F44B\" Content: Welcome to my blog socialIcons: - name: twitter url: \"https://twitter.com/\" - name: stackoverflow url: \"https://stackoverflow.com\" - name: github url: \"https://github.com/\" analytics: google: SiteVerificationTag: \"XYZabc\" bing: SiteVerificationTag: \"XYZabc\" yandex: SiteVerificationTag: \"XYZabc\" cover: hidden: true # hide everywhere but not in structured data hiddenInList: true # hide on list pages and home hiddenInSingle: true # hide on single page editPost: URL: \"https://github.com//content\" Text: \"Suggest Changes\" # edit text appendFilePath: true # to append file path to Edit link # for search # https://fusejs.io/api/options.html fuseOpts: isCaseSensitive: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: [\"title\", \"permalink\", \"summary\", \"content\"] menu: main: - identifier: categories name: categories url: /categories/ weight: 10 - identifier: tags name: tags url: /tags/ weight: 20 - identifier: example name: example.org url: https://example.org weight: 30 # Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma # pygmentsUseClasses: true # markup: # highlight: # # anchorLineNos: true # codeFences: true # guessSyntax: true # lineNos: true # style: monokai Sample Page.md --- title: \"My 1st post\" date: 2020-09-15T11:30:03+00:00 # weight: 1 # aliases: [\"/first\"] tags: [\"first\"] author: \"Me\" # author: [\"Me\", \"You\"] # multiple authors showToc: true TocOpen: false draft: false hidemeta: false comments: false description: \"Desc Text.\" canonicalURL: \"https://canonical.url/to/page\" disableHLJS: true # to disable highlightjs disableShare: false disableHLJS: false hideSummary: false searchHidden: true ShowReadingTime: true ShowBreadCrumbs: true ShowPostNavLinks: true cover: image: \"\" # image path/url alt: \"\" # alt text caption: \"\" # display caption under cover relative: false # when using page bundles set this to true hidden: true # only hide on current single page editPost: URL: \"https://github.com//content\" Text: \"Suggest Changes\" # edit text appendFilePath: true # to append file path to Edit link --- You can use it by creating archetypes/post.md\nhugo new --kind post ","wordCount":"716","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-installation/"},"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>
Installation | Update
</h1>
<div class=post-meta><span title="2021-01-20 00:00:00 +0000 UTC">January 20, 2021</span>&nbsp;·&nbsp;4 min&nbsp;·&nbsp;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=#intro aria-label=Intro>Intro</a></li>
<li>
<a href=#guide aria-label=Guide>Guide</a><ul>
<li>
<a href=#method-1 aria-label="Method 1">Method 1</a></li>
<li>
<a href=#method-2 aria-label="Method 2">Method 2</a></li>
<li>
<a href=#method-3 aria-label="Method 3">Method 3</a></li>
<li>
<a href=#finally- aria-label="Finally &amp;hellip;">Finally &mldr;</a></li></ul>
</li>
<li>
<a href=#quick-links aria-label="Quick Links">Quick Links</a><ul>
<li>
<a href=#papermod---featurespapermod-features aria-label="Papermod - Features"><a href=../papermod-features>Papermod - Features</a></a></li>
<li>
<a href=#papermod---faqspapermod-how-to aria-label="Papermod - FAQs"><a href=../papermod-how-to>Papermod - FAQs</a></a></li>
<li>
<a href=#papermod---variablespapermod-variables aria-label="Papermod - Variables"><a href=../papermod-variables>Papermod - Variables</a></a></li>
<li>
<a href=#papermod---iconspapermod-icons aria-label="Papermod - Icons"><a href=../papermod-icons>Papermod - Icons</a></a></li>
<li>
<a href=#changeloghttpsgithubcomadityatelangehugo-papermodreleases aria-label=ChangeLog><a href=https://github.com/adityatelange/hugo-PaperMod/releases>ChangeLog</a></a></li></ul>
</li>
<li>
<a href=#sample-configyml aria-label="Sample config.yml">Sample <code>config.yml</code></a></li>
<li>
<a href=#sample-pagemd aria-label="Sample Page.md">Sample <code>Page.md</code></a>
</li>
</ul>
</div>
</details>
</div>
<div class=post-content><h2 id=intro>Intro<a hidden class=anchor aria-hidden=true href=#intro>#</a></h2>
<ul>
<li><strong>We&rsquo;ll be using <code>yml/yaml</code> format for all examples down below, I recommend using <code>yml</code> over <code>toml</code> as it is easier to read.</strong></li>
<li>You can find any <a href="https://www.google.com/search?q=yml+to+toml">YML to TOML</a> converters if necessary.</li>
</ul>
<hr>
<h2 id=guide>Guide<a hidden class=anchor aria-hidden=true href=#guide>#</a></h2>
<p>Follow <a href=https://gohugo.io/getting-started/quick-start/>Quick Start</a> guide to setup hugo and create a new site.</p>
<blockquote>
<p>Note: Use -f to select yml format</p>
<p><code>hugo new site &lt;name of site> -f yml</code></p>
</blockquote>
<p>Make sure you install latest version of <strong><code>hugo(>=0.82.0)</code></strong>.</p>
<p>After you have created a new site, at <a href=https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme>Step 3</a> follow the steps:</p>
<h3 id=method-1>Method 1<a hidden class=anchor aria-hidden=true href=#method-1>#</a></h3>
<p>Inside the folder of your Hugo site, run:</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-bash data-lang=bash>git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth<span style=color:#f92672>=</span><span style=color:#ae81ff>1</span>
</code></pre></div><p><strong>Note</strong>: You may use <code> --branch v5.0</code> to end of above command if you want to stick to specific release.</p>
<blockquote>
<p>Updating theme :</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-bash data-lang=bash>cd themes/PaperMod
git pull
</code></pre></div></blockquote>
<h3 id=method-2>Method 2<a hidden class=anchor aria-hidden=true href=#method-2>#</a></h3>
<p>you can use as <a href=https://www.atlassian.com/git/tutorials/git-submodule>submodule</a> with</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-bash data-lang=bash>git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth<span style=color:#f92672>=</span><span style=color:#ae81ff>1</span>
git submodule update --init --recursive <span style=color:#75715e># needed when you reclone your repo (submodules may not get cloned automatically)</span>
</code></pre></div><p><strong>Note</strong>: You may use <code> --branch v5.0</code> to end of above command if you want to stick to specific release.</p>
<blockquote>
<p>Updating theme :</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-bash data-lang=bash>git submodule update --remote --merge
</code></pre></div></blockquote>
<h3 id=method-3>Method 3<a hidden class=anchor aria-hidden=true href=#method-3>#</a></h3>
<p>Or you can Download as Zip from Github Page and extract in your themes directory</p>
<p>Direct Links:</p>
<ul>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/master.zip>Master Branch (Latest)</a></li>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip>v5.0</a></li>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip>v4.0</a></li>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip>v3.0</a></li>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip>v2.0</a></li>
<li><a href=https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip>v1.0</a></li>
</ul>
<h3 id=finally->Finally &mldr;<a hidden class=anchor aria-hidden=true href=#finally->#</a></h3>
<p>Add in <code>config.yml</code>:</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>theme</span>: <span style=color:#e6db74>&#34;PaperMod&#34;</span>
</code></pre></div><hr>
<h2 id=quick-links>Quick Links<a hidden class=anchor aria-hidden=true href=#quick-links>#</a></h2>
<ul>
<li>
<h3 id=papermod---featurespapermod-features><a href=../papermod-features>Papermod - Features</a><a hidden class=anchor aria-hidden=true href=#papermod---featurespapermod-features>#</a></h3>
</li>
<li>
<h3 id=papermod---faqspapermod-how-to><a href=../papermod-how-to>Papermod - FAQs</a><a hidden class=anchor aria-hidden=true href=#papermod---faqspapermod-how-to>#</a></h3>
</li>
<li>
<h3 id=papermod---variablespapermod-variables><a href=../papermod-variables>Papermod - Variables</a><a hidden class=anchor aria-hidden=true href=#papermod---variablespapermod-variables>#</a></h3>
</li>
<li>
<h3 id=papermod---iconspapermod-icons><a href=../papermod-icons>Papermod - Icons</a><a hidden class=anchor aria-hidden=true href=#papermod---iconspapermod-icons>#</a></h3>
</li>
<li>
<h3 id=changeloghttpsgithubcomadityatelangehugo-papermodreleases><a href=https://github.com/adityatelange/hugo-PaperMod/releases>ChangeLog</a><a hidden class=anchor aria-hidden=true href=#changeloghttpsgithubcomadityatelangehugo-papermodreleases>#</a></h3>
</li>
</ul>
<hr>
<h2 id=sample-configyml>Sample <code>config.yml</code><a hidden class=anchor aria-hidden=true href=#sample-configyml>#</a></h2>
<blockquote>
<p><strong>Example Site Structure is present here</strong>: <a href=https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/>exampleSite</a></p>
</blockquote>
<p><strong>Use appropriately</strong></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>baseURL</span>: <span style=color:#e6db74>&#34;https://examplesite.com/&#34;</span>
<span style=color:#f92672>title</span>: <span style=color:#ae81ff>ExampleSite</span>
<span style=color:#f92672>paginate</span>: <span style=color:#ae81ff>5</span>
<span style=color:#f92672>theme</span>: <span style=color:#ae81ff>PaperMod</span>
<span style=color:#f92672>enableRobotsTXT</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>buildDrafts</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>buildFuture</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>buildExpired</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>googleAnalytics</span>: <span style=color:#ae81ff>UA-123-45</span>
<span style=color:#f92672>minify</span>:
<span style=color:#f92672>disableXML</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>minifyOutput</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>params</span>:
<span style=color:#f92672>env</span>: <span style=color:#ae81ff>production</span> <span style=color:#75715e># to enable google analytics, opengraph, twitter-cards and schema.</span>
<span style=color:#f92672>title</span>: <span style=color:#ae81ff>ExampleSite</span>
<span style=color:#f92672>description</span>: <span style=color:#e6db74>&#34;ExampleSite description&#34;</span>
<span style=color:#f92672>keywords</span>: [<span style=color:#ae81ff>Blog, Portfolio, PaperMod]</span>
<span style=color:#f92672>author</span>: <span style=color:#ae81ff>Me</span>
<span style=color:#75715e># author: [&#34;Me&#34;, &#34;You&#34;] # multiple authors</span>
<span style=color:#f92672>images</span>: [<span style=color:#e6db74>&#34;&lt;link or path of image for opengraph, twitter-cards&gt;&#34;</span>]
<span style=color:#f92672>DateFormat</span>: <span style=color:#e6db74>&#34;January 2, 2006&#34;</span>
<span style=color:#f92672>defaultTheme</span>: <span style=color:#ae81ff>auto</span> <span style=color:#75715e># dark, light</span>
<span style=color:#f92672>disableThemeToggle</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>ShowReadingTime</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowShareButtons</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowPostNavLinks</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowBreadCrumbs</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowCodeCopyButtons</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>disableSpecial1stPost</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>disableScrollToTop</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>comments</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>hidemeta</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>hideSummary</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>showtoc</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>tocopen</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>assets</span>:
<span style=color:#75715e># disableHLJS: true # to disable highlight.js</span>
<span style=color:#75715e># disableFingerprinting: true</span>
<span style=color:#f92672>favicon</span>: <span style=color:#e6db74>&#34;&lt;link / abs url&gt;&#34;</span>
<span style=color:#f92672>favicon16x16</span>: <span style=color:#e6db74>&#34;&lt;link / abs url&gt;&#34;</span>
<span style=color:#f92672>favicon32x32</span>: <span style=color:#e6db74>&#34;&lt;link / abs url&gt;&#34;</span>
<span style=color:#f92672>apple_touch_icon</span>: <span style=color:#e6db74>&#34;&lt;link / abs url&gt;&#34;</span>
<span style=color:#f92672>safari_pinned_tab</span>: <span style=color:#e6db74>&#34;&lt;link / abs url&gt;&#34;</span>
<span style=color:#f92672>label</span>:
<span style=color:#f92672>text</span>: <span style=color:#e6db74>&#34;Home&#34;</span>
<span style=color:#f92672>icon</span>: <span style=color:#ae81ff>/apple-touch-icon.png</span>
<span style=color:#f92672>iconHeight</span>: <span style=color:#ae81ff>35</span>
<span style=color:#75715e># profile-mode</span>
<span style=color:#f92672>profileMode</span>:
<span style=color:#f92672>enabled</span>: <span style=color:#66d9ef>false</span> <span style=color:#75715e># needs to be explicitly set</span>
<span style=color:#f92672>title</span>: <span style=color:#ae81ff>ExampleSite</span>
<span style=color:#f92672>subtitle</span>: <span style=color:#e6db74>&#34;This is subtitle&#34;</span>
<span style=color:#f92672>imageUrl</span>: <span style=color:#e6db74>&#34;&lt;img location&gt;&#34;</span>
<span style=color:#f92672>imageWidth</span>: <span style=color:#ae81ff>120</span>
<span style=color:#f92672>imageHeight</span>: <span style=color:#ae81ff>120</span>
<span style=color:#f92672>imageTitle</span>: <span style=color:#ae81ff>my image</span>
<span style=color:#f92672>buttons</span>:
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>Posts</span>
<span style=color:#f92672>url</span>: <span style=color:#ae81ff>posts</span>
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>Tags</span>
<span style=color:#f92672>url</span>: <span style=color:#ae81ff>tags</span>
<span style=color:#75715e># home-info mode</span>
<span style=color:#f92672>homeInfoParams</span>:
<span style=color:#f92672>Title</span>: <span style=color:#e6db74>&#34;Hi there \U0001F44B&#34;</span>
<span style=color:#f92672>Content</span>: <span style=color:#ae81ff>Welcome to my blog</span>
<span style=color:#f92672>socialIcons</span>:
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>twitter</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;https://twitter.com/&#34;</span>
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>stackoverflow</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;https://stackoverflow.com&#34;</span>
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>github</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;https://github.com/&#34;</span>
<span style=color:#f92672>analytics</span>:
<span style=color:#f92672>google</span>:
<span style=color:#f92672>SiteVerificationTag</span>: <span style=color:#e6db74>&#34;XYZabc&#34;</span>
<span style=color:#f92672>bing</span>:
<span style=color:#f92672>SiteVerificationTag</span>: <span style=color:#e6db74>&#34;XYZabc&#34;</span>
<span style=color:#f92672>yandex</span>:
<span style=color:#f92672>SiteVerificationTag</span>: <span style=color:#e6db74>&#34;XYZabc&#34;</span>
<span style=color:#f92672>cover</span>:
<span style=color:#f92672>hidden</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># hide everywhere but not in structured data</span>
<span style=color:#f92672>hiddenInList</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># hide on list pages and home</span>
<span style=color:#f92672>hiddenInSingle</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># hide on single page</span>
<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:#75715e># for search</span>
<span style=color:#75715e># https://fusejs.io/api/options.html</span>
<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:#f92672>menu</span>:
<span style=color:#f92672>main</span>:
- <span style=color:#f92672>identifier</span>: <span style=color:#ae81ff>categories</span>
<span style=color:#f92672>name</span>: <span style=color:#ae81ff>categories</span>
<span style=color:#f92672>url</span>: <span style=color:#ae81ff>/categories/</span>
<span style=color:#f92672>weight</span>: <span style=color:#ae81ff>10</span>
- <span style=color:#f92672>identifier</span>: <span style=color:#ae81ff>tags</span>
<span style=color:#f92672>name</span>: <span style=color:#ae81ff>tags</span>
<span style=color:#f92672>url</span>: <span style=color:#ae81ff>/tags/</span>
<span style=color:#f92672>weight</span>: <span style=color:#ae81ff>20</span>
- <span style=color:#f92672>identifier</span>: <span style=color:#ae81ff>example</span>
<span style=color:#f92672>name</span>: <span style=color:#ae81ff>example.org</span>
<span style=color:#f92672>url</span>: <span style=color:#ae81ff>https://example.org</span>
<span style=color:#f92672>weight</span>: <span style=color:#ae81ff>30</span>
<span style=color:#75715e># Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma</span>
<span style=color:#75715e># pygmentsUseClasses: true</span>
<span style=color:#75715e># markup:</span>
<span style=color:#75715e># highlight:</span>
<span style=color:#75715e># # anchorLineNos: true</span>
<span style=color:#75715e># codeFences: true</span>
<span style=color:#75715e># guessSyntax: true</span>
<span style=color:#75715e># lineNos: true</span>
<span style=color:#75715e># style: monokai</span>
</code></pre></div><hr>
<h2 id=sample-pagemd>Sample <code>Page.md</code><a hidden class=anchor aria-hidden=true href=#sample-pagemd>#</a></h2>
<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>title</span>: <span style=color:#e6db74>&#34;My 1st post&#34;</span>
<span style=color:#f92672>date</span>: <span style=color:#e6db74>2020-09-15T11:30:03</span><span style=color:#ae81ff>+00</span>:<span style=color:#ae81ff>00</span>
<span style=color:#75715e># weight: 1</span>
<span style=color:#75715e># aliases: [&#34;/first&#34;]</span>
<span style=color:#f92672>tags</span>: [<span style=color:#e6db74>&#34;first&#34;</span>]
<span style=color:#f92672>author</span>: <span style=color:#e6db74>&#34;Me&#34;</span>
<span style=color:#75715e># author: [&#34;Me&#34;, &#34;You&#34;] # multiple authors</span>
<span style=color:#f92672>showToc</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>TocOpen</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>draft</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>hidemeta</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>comments</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>description</span>: <span style=color:#e6db74>&#34;Desc Text.&#34;</span>
<span style=color:#f92672>canonicalURL</span>: <span style=color:#e6db74>&#34;https://canonical.url/to/page&#34;</span>
<span style=color:#f92672>disableHLJS</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># to disable highlightjs</span>
<span style=color:#f92672>disableShare</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>disableHLJS</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>hideSummary</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>searchHidden</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowReadingTime</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowBreadCrumbs</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowPostNavLinks</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>cover</span>:
<span style=color:#f92672>image</span>: <span style=color:#e6db74>&#34;&lt;image path/url&gt;&#34;</span> <span style=color:#75715e># image path/url</span>
<span style=color:#f92672>alt</span>: <span style=color:#e6db74>&#34;&lt;alt text&gt;&#34;</span> <span style=color:#75715e># alt text</span>
<span style=color:#f92672>caption</span>: <span style=color:#e6db74>&#34;&lt;text&gt;&#34;</span> <span style=color:#75715e># display caption under cover</span>
<span style=color:#f92672>relative</span>: <span style=color:#66d9ef>false</span> <span style=color:#75715e># when using page bundles set this to true</span>
<span style=color:#f92672>hidden</span>: <span style=color:#66d9ef>true</span> <span style=color:#75715e># only hide on current single page</span>
<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>
---
</code></pre></div><p>You can use it by creating <code>archetypes/post.md</code></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-shell data-lang=shell>hugo new --kind post &lt;name&gt;
</code></pre></div><hr>
</div>
<footer class=post-footer>
<ul class=post-tags>
<li><a href=/tags/papermod/>PaperMod</a></li>
</ul>
<nav class=paginav>
<a class=next href=/posts/papermod/papermod-features/>
<span class=title>Next »</span>
<br>
<span>Features</span>
</a>
</nav>
</footer>
</article>
</main>
<footer class=footer>
<span>&copy; 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>