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

98 lines
22 KiB
HTML
Raw Normal View History

<!doctype html><html lang=en><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"><title>Papermod - Installation - PaperMod</title><meta name=description content="Guide Follow this guide to setup hugo and create a new site. Make sure you install latest version of hugo(>=0.57.1).
After you have created a new site, at Step 3 follow the steps:
Inside the folder of your Hugo site, run:
git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1 Updating theme :
cd themes/hugo-PaperMod git pull or you can use as submodule with
git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod Updating theme with submodule :"><meta name=keywords content="/"><meta name=author content="Aditya Telange"><link rel=canonical href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-installation/><link href=https://adityatelange.github.io/hugo-PaperMod/assets/css/stylesheet.min.17511ac7ee070872f1954e3feb5828d476e3ed559a75e46f00b477535e9a70fb.css integrity="sha256-F1Eax+4HCHLxlU4/61go1Hbj7VWadeRvALR3U16acPs=" rel="preload stylesheet" as=style><link rel=apple-touch-icon href=https://adityatelange.github.io/hugo-PaperMod/apple-touch-icon.png><link rel=icon href=https://adityatelange.github.io/hugo-PaperMod/favicon.ico><meta name=generator content="Hugo 0.76.3"></head><body class=single id=top><script>if(localStorage.getItem("pref-theme")==="dark"){document.body.classList.add('dark');}else if(localStorage.getItem("pref-theme")==="light"){document.body.classList.remove('dark')}else{if(window.matchMedia('(prefers-color-scheme: dark)').matches){document.body.classList.add('dark');}}</script><noscript><style type=text/css>.theme-toggle,.top-link{display:none}</style></noscript><header class=header><nav class=nav><p class=logo><a href=https://adityatelange.github.io/hugo-PaperMod/>PaperMod</a>
<span class=theme-toggle><a id=theme-toggle><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></p><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 - Installation</h1><div class=post-meta><time>September 15, 2020</time>&nbsp;·&nbsp;2 min&nbsp;·&nbsp;Aditya Telange</div></header><div class=toc><details open><summary><div class=details>Table of Contents</div></summary><blockquote><ul><li><a href=#guide>Guide</a><ul><li><a href=#sample-configyml>Sample <code>config.yml</code></a></li><li><a href=#sample-pagemd>Sample <code>Page.md</code></a></li><li><a href=#papermod---featurespapermod-features><a href=../papermod-features>Papermod - Features</a></a></li><li><a href=#papermod---how-to-guidepapermod-how-to-guide><a href=../papermod-how-to-guide>Papermod - How to Guide</a></a></li><li><a href=#papermod---iconspapermod-icons><a href=../papermod-icons>Papermod - Icons</a></a></li></ul></li></ul></blockquote></details></div><div class=post-content><h2 id=guide>Guide</h2><p>Follow <a href=https://gohugo.io/getting-started/quick-start/>this</a> guide to setup hugo and create a new site.
Make sure you install latest version of <code>hugo</code>(>=0.57.1).</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><p>Inside the folder of your Hugo site, run:</p><blockquote><pre><code class=language-console data-lang=console>git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1
</code></pre><blockquote><p>Updating theme :</p><pre><code class=language-console data-lang=console>cd themes/hugo-PaperMod
git pull
</code></pre></blockquote></blockquote><p><strong>or</strong> you can use as <a href=https://www.atlassian.com/git/tutorials/git-submodule>submodule</a> with</p><blockquote><pre><code class=language-console data-lang=console>git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod
</code></pre><blockquote><p>Updating theme with submodule :</p><pre><code class=language-console data-lang=console>git submodule update --remote --merge
</code></pre></blockquote></blockquote><p>Then change in <code>config.yml</code>:</p><blockquote></blockquote><div class=highlight><pre 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;hugo-PaperMod&#34;</span>
</code></pre></div><p>Example Site Structure is present here: <a href=https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/>exampleSite</a></p><hr><h3 id=sample-configyml>Sample <code>config.yml</code></h3><div class=highlight><pre 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>&#39;https://examplesite.com&#39;</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>hugo-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>buildExpored</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>&#39;ExampleSite&#39;</span><span style=color:#ae81ff>s description&#39;</span>
<span style=color:#f92672>author</span>: <span style=color:#ae81ff>Me</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>ShowReadingTime</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>ShowShareButtons</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>comments</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>defaultTheme</span>: <span style=color:#ae81ff>auto</span>
<span style=color:#f92672>disableThemeToggle </span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>disableSpecial1stPost </span>: <span style=color:#66d9ef>false</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:#75715e># imageUrl: &#39;&lt;img location&gt;&#39;</span>
<span style=color:#75715e># imageTitle: 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>&#39;https://twitter.com/&#39;</span>
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>stackoverflow</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#39;https://stackoverflow.com&#39;</span>
- <span style=color:#f92672>name</span>: <span style=color:#ae81ff>github</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#39;https://github.com/&#39;</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>
</code></pre></div><hr><h3 id=sample-pagemd>Sample <code>Page.md</code></h3><div class=highlight><pre 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:#f92672>weight</span>: <span style=color:#ae81ff>1</span>
<span style=color:#f92672>aliases</span>: [<span style=color:#e6db74>&#39;/first&#39;</span>]
<span style=color:#f92672>tags</span>: [<span style=color:#e6db74>&#39;first&#39;</span>]
<span style=color:#f92672>author</span>: <span style=color:#e6db74>&#34;Me&#34;</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>disableShare</span>: <span style=color:#66d9ef>false</span>
<span style=color:#f92672>cover</span>:
<span style=color:#f92672>image</span>: <span style=color:#e6db74>&#39;&lt;image path/url&gt;&#39;</span>
<span style=color:#f92672>alt</span>: <span style=color:#e6db74>&#39;&lt;alt text&gt;&#39;</span>
<span style=color:#f92672>caption</span>: <span style=color:#e6db74>&#39;&lt;text&gt;&#39;</span>
<span style=color:#f92672>comments</span>: <span style=color:#66d9ef>false</span>
---
</code></pre></div><hr><h3 id=papermod---featurespapermod-features><a href=../papermod-features>Papermod - Features</a></h3><h3 id=papermod---how-to-guidepapermod-how-to-guide><a href=../papermod-how-to-guide>Papermod - How to Guide</a></h3><h3 id=papermod---iconspapermod-icons><a href=../papermod-icons>Papermod - Icons</a></h3></div><footer class=post-footer><ul class=post-tags><li><a href=https://adityatelange.github.io/hugo-PaperMod/tags/papermod>PaperMod</a></li></ul><div class=share-buttons><a target=_blank rel="noopener noreferrer" aria-label="share Papermod - Installation on twitter" href="https://twitter.com/intent/tweet/?text=Papermod%20-%20Installation&url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-installation%2f"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512h-386.892c-34.524.0-62.554-28.03-62.554-62.554v-386.892c0-34.524 28.029-62.554 62.554-62.554h386.892zm-253.927 424.544c135.939.0 210.268-112.643 210.268-210.268.0-3.218.0-6.437-.153-9.502 14.406-10.421 26.973-23.448 36.935-38.314-13.18 5.824-27.433 9.809-42.452 11.648 15.326-9.196 26.973-23.602 32.49-40.92-14.252 8.429-30.038 14.56-46.896 17.931-13.487-14.406-32.644-23.295-53.946-23.295-40.767.0-73.87 33.104-73.87 73.87.0 5.824.613 11.494 1.992 16.858-61.456-3.065-115.862-32.49-152.337-77.241-6.284 10.881-9.962 23.601-9.962 37.088.0 25.594 13.027 48.276 32.95 61.456-12.107-.307-23.448-3.678-33.41-9.196v.92c0 35.862 25.441 65.594 59.311 72.49-6.13 1.686-12.72 2.606-19.464 2.606-4.751.0-9.348-.46-13.946-1.38 9.349 29.426 36.628 50.728 68.965 51.341-25.287 19.771-57.164 31.571-91.8 31.571-5.977.0-11.801-.306-17.625-1.073 32.337 21.15 71.264 33.41 112.95 33.41z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Papermod - Installation on linkedin" href="https://www.linkedin.com/shareArticle?mini=true&url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-installation%2f&title=Papermod%20-%20Installation&summary=Papermod%20-%20Installation&source=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-installation%2f"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512h-386.892c-34.524.0-62.554-28.03-62.554-62.554v-386.892c0-34.524 28.029-62.554 62.554-62.554h386.892zM160.461 423.278V197.561h-75.04v225.717h75.04zm270.539.0v-129.439c0-69.333-37.018-101.586-86.381-101.586-39.804.0-57.634 21.891-67.617 37.266v-31.958h-75.021c.995 21.181.0 225.717.0 225.717h75.02v-126.056c0-6.748.486-13.492 2.474-18.315 5.414-13.475 17.767-27.434 38.494-27.434 27.135.0 38.007 20.707 38.007 51.037v120.768h75.024zm-307.552-334.556c-25.674.0-42.448 16.879-42.448 39.002.0 21.658 16.264 39.002 41.455 39.002h.484c26.165.0 42.452-17.344 42.452-39.002-.485-22.092-16.241-38.954-41.943-39.002z"/></svg></a><a target=_blank rel="noopener noreferrer" aria-label="share Papermod - Installation on reddit" href="https://reddit.com/submit?url=https%3a%2f%2fadityatelange.github.io%2fhugo-PaperMod%2fposts%2fpapermod%2fpapermod-installation%2f&title=Papermod%20-%20Installation"><svg viewBox="0 0 512 512"><path d="M449.446.0C483.971.0 512 28.03 512 62.554v386.892C512 483.97 483.97 512 449.446 512h-386.892c-34.524.0-62.554-28.03-62.554-62.554v-386.892c0-34.524 28.029-62.554 62.554-62.554h386.892zM446 265.638c0-22.964-18.616-41.58-41.58-41.58-11.211.0-21.361 4.457-28.841 11.666-28.424-20.508-67.586-33.757-111.204-35.278l18.941-89.121 61.884 13.157c.756 15.734 13.642 28.29 29.56 28.29 16.407.0 29.706-13.299 29.706-29.701.0-16.403-13.299-29.702-29.706-29.702-11.666.0-21.657 6.792-26.515 16.578l-69.105-14.69c-1.922-.418-3.939-.042-5.585 1.036-1.658 1.073-2.811 2.761-3.224 4.686l-21.152 99.438c-44.258 1.228-84.046 14.494-112.837 35.232-7.468-7.164-17.589-11.591-28.757-11.591-22.965.0-41.585 18.616-41.585 41.58.0 16.896 10.095 31.41 24.568 37.918-.639 4.135-.99 8.328-.99 12.576.0 63.977 74.469 115.836 166.33 115.836s166.334-51.859 166.334-115.836c0
<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"><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 src=https://adityatelange.github.io/hugo-PaperMod/assets/js/highlight.min.e7afc2928c0925d65c4732dfebe147014d91299a98e819e4b42f25c4fa68e91c.js integrity="sha256-56/CkowJJdZcRzLf6+FHAU2RKZqY6BnktC8lxPpo6Rw="></script><script>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();document.querySelector(this.getAttribute("href")).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>