This commit is contained in:
adityatelange committed 2021-02-01 05:47:55 +00:00
1 parent 1c7ebc8ef6
commit c18b4fea21
13 files changed
+77 -37

No files matched your search

+31 -12
View File
@@ -1,14 +1,22 @@
<!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>Features | PaperMod</title><meta name=keywords content="PaperMod"><meta name=description content="Get known about All Features in PaperMod"><meta name=author content="Aditya Telange"><link rel=canonical href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><link href=/hugo-PaperMod/assets/css/stylesheet.min.23ca66c33946ea0cee2c04d1168bf7a5e397fb03f9bcd6cc11a233ae8e51b097.css integrity="sha256-I8pmwzlG6gzuLATRFov3peOX+wP5vNbMEaIzro5RsJc=" 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.80.0"><link rel=alternate hreflang=en href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><meta property="og:title" content="Features"><meta property="og:description" content="Get known about All Features in PaperMod"><meta property="og:type" content="article"><meta property="og:url" content="https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/"><meta property="og:image" content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><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_large_image"><meta name=twitter:image content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><meta name=twitter:title content="Features"><meta name=twitter:description content="Get known about All Features in PaperMod"><script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Features","name":"Features","description":"Get known about All Features in PaperMod","keywords":["PaperMod"],"articleBody":"Assets (js/css) The following is enabled by default\n minification - makes the assets size smallest as possible. bundling - bundles all the styles in one single asset fingerprint/intergity check. Default Theme light/dark/auto params: # defaultTheme: light # defaultTheme: dark defaultTheme: auto # to switch between dark or light according to browser theme Theme Switch Toggle (enabled by default) Shows icon besides title of page to change theme\nTo disable it :\ndisableThemeToggle: true You can refer following table for better understanding…\n defaultTheme disableThemeToggle checks local storage? checks system theme? Info auto true No Yes only system theme false Yes (if not-2) Yes (2) switch present dark true No No force dark only false Yes No switch present light true No No force light only false Yes No switch present Archives Layout Create a page with archive.md in content directory with following content\n--- title: \"Archive\" # in any language you want layout: \"archives\" # is necessary url: \"/archive\" summary: \"archive\" --- Note: Archives Layout does not support Multilingual Month Translations.\nex: archives.md\n Regular Mode (default-mode) Home-Info Mode Use 1st entry as some Information\nadd following to config file\nparams: homeInfoParams: Title: Hi there wave Content: Can be Info, links, about... socialIcons: # optional - name: \"\" url: \"\" - name: \"\" url: \"\" ex. config.yml#L106\n Profile Mode Shows Index/Home page as Full Page with Social Links and Image\nadd following to config file\nparams: profileMode: enabled: true title: \"\" # optional default will be site title imageUrl: \"\" # optional imageTitle: \"\" # optional imageWidth: 120 # custom size imageHeight: 120 # custom size buttons: - name: Archive url: \"/archive\" - name: Github url: \"https://github.com/\" socialIcons: # optional - name: \"\" url: \"\" - name: \"\" url: \"\" Search Add the following to site config, config.yml\noutputs: home: - HTML - RSS - JSON # is necessary Create a page with search.md in content directory with following content\n--- title: \"Search\" # in any language you want layout: \"search\" # is necessary # url: \"/archive\" summary: \"search\" --- For Multilingual use search..md ex. search.es.md.\nNote: Search will work only on current language, user is currently on !\nCustomizing Fusejs Options\nRefer https://fusejs.io/api/options.html for Options, Add those as shown below.\nparamLine truncated
<span class=logo-switches><a 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></a><ul class=lang-switch><li>|</li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fr/ title=:fr: aria-label=:fr:>🇫🇷</a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fa/ title=Fa aria-label=Fa>Fa</a></li></ul></span></div><ul id=menu onscroll=menu_on_scroll()><li><a href=https://adityatelange.github.io/hugo-PaperMod/archives title=Archive><span>Archive</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/categories/ title=Categories><span>Categories</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/search/ title="Search (Alt + /)" accesskey=/><span>Search</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/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=https://adityatelange.github.io/hugo-PaperMod/>Home</a>&nbsp;»&nbsp;<a href=https://adityatelange.github.io/hugo-PaperMod/posts/>Posts</a>&nbsp;»&nbsp;<a href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/>Sub-Section PaperMod</a></div><h1 class=post-title>Features</h1><div class=post-meta>January 20, 2021&nbsp;·&nbsp;4 min&nbsp;·&nbsp;Aditya Telange</div></header><div class=toc><details open><summary accesskey=c title="(Alt + C)"><div class=details>Table of Contents</div></summary><div class=inner><ul><li><a href=#assets-jscss aria-label="Assets (js/css)">Assets (js/css)</a></li><li><a href=#default-theme-lightdarkauto aria-label="Default Theme light/dark/auto">Default Theme light/dark/auto</a></li><li><a href=#theme-switch-toggle-enabled-by-default aria-label="Theme Switch Toggle (enabled by default)">Theme Switch Toggle (enabled by default)</a></li><li><a href=#archives-layout aria-label="Archives Layout">Archives Layout</a></li><li><a href=#regular-mode-default-mode aria-label="Regular Mode (default-mode)">Regular Mode (default-mode)</a></li><li><a href=#home-info-mode aria-label="Home-Info Mode">Home-Info Mode</a></li><li><a href=#profile-mode aria-label="Profile Mode">Profile Mode</a></li><li><a href=#search aria-label=Search>Search</a></li><li><a href=#draft-page-indication aria-label="Draft Page indication">Draft Page indication</a></li><li><a href=#post-cover-image aria-label="Post Cover Image">Post Cover Image</a></li><li><a href=#share-buttons-on-post aria-label="Share Buttons on post">Share Buttons on post</a></li><li><a href=#show-post-reading-time aria-label="Show post reading time">Show post reading time</a></li><li><a href=#show-table-of-contents-toc-on-blog-post aria-label="Show Table of Contents (Toc) on blog post">Show Table of Contents (Toc) on blog post</a></li><li><a href=#multiple-authors aria-label="Multiple Authors">Multiple Authors</a></li><li><a href=#comments aria-label=Comments>Comments</a></li><li><a href=#accesskeys aria-label=AccessKeys>AccessKeys</a></li><li><a href=#enhanced-seo aria-label="Enhanced SEO">Enhanced SEO</a></li><li><a href=#multilingual-support aria-label="Multilingual Support">Multilingual Support</a></li><li><a href=#misc aria-label=Misc>Misc</a><ul><li><a href=#scroll-bar-themed-by-default aria-label="Scroll-Bar themed (by default)">Scroll-Bar themed (by default)</a></li><li><a href=#smooth-scroll-between-in-page-links-by-default aria-label="Smooth Scroll between in-page links (by default)">Smooth Scroll between in-page links (by default)</a></li><li><a href=#scroll-to-top-button-by-default aria-label="Scroll-to-Top Button (by default)">Scroll-to-Top Button (by default)</a></li><li><a href=#google-analytics-integration aria-label="Google Analytics integration">Google Analytics integration</a></li><li><a href=#syntax-highlighting aria-label="Syntax highlighting">Syntax highlighting</a></li><li><a href=#rss-feeds aria-label="RSS feeds">RSS feeds</a></li></ul></li></ul></div></details></div><div class=post-content><h3 id=assets-jscss>Assets (js/css)<a hidden class=anchor aria-hidden=true href=#assets-jscss>#</a></h3><p>The following is enabled by default</p><ul><li><a href=https://gohugo.io/hugo-pLine truncated
<!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>Features | PaperMod</title><meta name=keywords content="PaperMod"><meta name=description content="Get known about All Features in PaperMod"><meta name=author content="Aditya Telange"><link rel=canonical href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><link href=/hugo-PaperMod/assets/css/stylesheet.min.23ca66c33946ea0cee2c04d1168bf7a5e397fb03f9bcd6cc11a233ae8e51b097.css integrity="sha256-I8pmwzlG6gzuLATRFov3peOX+wP5vNbMEaIzro5RsJc=" 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.80.0"><link rel=alternate hreflang=en href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><meta property="og:title" content="Features"><meta property="og:description" content="Get known about All Features in PaperMod"><meta property="og:type" content="article"><meta property="og:url" content="https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/"><meta property="og:image" content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><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_large_image"><meta name=twitter:image content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><meta name=twitter:title content="Features"><meta name=twitter:description content="Get known about All Features in PaperMod"><script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Features","name":"Features","description":"Get known about All Features in PaperMod","keywords":["PaperMod"],"articleBody":"Intro We’ll be using yml/yaml format for all examples down below, I recommend using yml over toml as it is easier to read.\n You can find any YML to TOML converters if necessary.\n Assets (js/css) The following is enabled by default\n minification - makes the assets size smallest as possible. bundling - bundles all the styles in one single asset fingerprint/intergity check. Default Theme light/dark/auto params: # defaultTheme: light # defaultTheme: dark defaultTheme: auto # to switch between dark or light according to browser theme Theme Switch Toggle (enabled by default) Shows icon besides title of page to change theme\nTo disable it :\ndisableThemeToggle: true You can refer following table for better understanding…\n defaultTheme disableThemeToggle checks local storage? checks system theme? Info auto true No Yes only system theme false Yes (if not-2) Yes (2) switch present dark true No No force dark only false Yes No switch present light true No No force light only false Yes No switch present Archives Layout Create a page with archive.md in content directory with following content\n. ├── config.yml ├── content/ │ ├── archives.md and add the following to it\n--- title: \"Archive\" layout: \"archives\" url: \"/archives/\" summary: archives --- Note: Archives Layout does not support Multilingual Month Translations.\nex: archives.md\n Regular Mode (default-mode) Home-Info Mode Use 1st entry as some Information\nadd following to config file\nparams: homeInfoParams: Title: Hi there wave Content: Can be Info, links, about... socialIcons: # optional - name: \"\" url: \"\" - name: \"\" url: \"\" ex. config.yml#L106\n Profile Mode Shows Index/Home page as Full Page with Social Links and Image\nadd following to config file\nparams: profileMode: enabled: true title: \"\" # optional default will be site title imageUrl: \"\" # optional imageTitle: \"\" # optional imageWidth: 120 # custom size imageHeight: 120 # custom size buttons: - name: Archive url: \"/archive\" - name: Github url: \"https://github.com/\" socialIcons: # optional - name: \"\" url: \"\" - name: \"\" url: \"\" Search PaperMod uses Fuse.js Basic for seach functionality\nAdd the following to site config, config.yml\noutputs: home: - HTML - RSS - JSON # is necessary Create a page with search.md in content directory with following content\n--- title: \"Search\" # in any language you want layout: \"search\" # Line truncated
<span class=logo-switches><a 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></a><ul class=lang-switch><li>|</li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fr/ title=:fr: aria-label=:fr:>🇫🇷</a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/fa/ title=Fa aria-label=Fa>Fa</a></li></ul></span></div><ul id=menu onscroll=menu_on_scroll()><li><a href=https://adityatelange.github.io/hugo-PaperMod/archives title=Archive><span>Archive</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/categories/ title=Categories><span>Categories</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/search/ title="Search (Alt + /)" accesskey=/><span>Search</span></a></li><li><a href=https://adityatelange.github.io/hugo-PaperMod/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=https://adityatelange.github.io/hugo-PaperMod/>Home</a>&nbsp;»&nbsp;<a href=https://adityatelange.github.io/hugo-PaperMod/posts/>Posts</a>&nbsp;»&nbsp;<a href=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/>PaperMod</a></div><h1 class=post-title>Features</h1><div class=post-meta>January 20, 2021&nbsp;·&nbsp;5 min&nbsp;·&nbsp;Aditya Telange</div></header><div class=toc><details open><summary accesskey=c title="(Alt + C)"><div class=details>Table of Contents</div></summary><div class=inner><ul><li><a href=#intro aria-label=Intro>Intro</a><ul><li><a href=#assets-jscss aria-label="Assets (js/css)">Assets (js/css)</a></li><li><a href=#default-theme-lightdarkauto aria-label="Default Theme light/dark/auto">Default Theme light/dark/auto</a></li><li><a href=#theme-switch-toggle-enabled-by-default aria-label="Theme Switch Toggle (enabled by default)">Theme Switch Toggle (enabled by default)</a></li><li><a href=#archives-layout aria-label="Archives Layout">Archives Layout</a></li><li><a href=#regular-mode-default-mode aria-label="Regular Mode (default-mode)">Regular Mode (default-mode)</a></li><li><a href=#home-info-mode aria-label="Home-Info Mode">Home-Info Mode</a></li><li><a href=#profile-mode aria-label="Profile Mode">Profile Mode</a></li><li><a href=#search aria-label=Search>Search</a></li><li><a href=#draft-page-indication aria-label="Draft Page indication">Draft Page indication</a></li><li><a href=#post-cover-image aria-label="Post Cover Image">Post Cover Image</a></li><li><a href=#share-buttons-on-post aria-label="Share Buttons on post">Share Buttons on post</a></li><li><a href=#show-post-reading-time aria-label="Show post reading time">Show post reading time</a></li><li><a href=#show-table-of-contents-toc-on-blog-post aria-label="Show Table of Contents (Toc) on blog post">Show Table of Contents (Toc) on blog post</a></li><li><a href=#breadcrumb-navigation aria-label="BreadCrumb Navigation">BreadCrumb Navigation</a></li><li><a href=#other-posts-suggestion-below-a-post aria-label="Other Posts suggestion below a post">Other Posts suggestion below a post</a></li><li><a href=#multiple-authors aria-label="Multiple Authors">Multiple Authors</a></li><li><a href=#comments aria-label=Comments>Comments</a></li><li><a href=#accesskeys aria-label=AccessKeys>AccessKeys</a></li><li><a href=#enhanced-seo aria-label="Enhanced SEO">Enhanced SEO</a></li><li><a href=#multilingual-support aria-label="Multilingual Support">Multilingual Support</a></li><li><a href=#misc aria-label=Misc>Misc</a><ul><li><a href=#scroll-bar-themed-by-default aria-label="Scroll-Bar themed (by default)">Scroll-Bar themed (by default)</a></li><li><a href=#smooth-scroll-between-in-page-links-by-default aria-label="Smooth Scroll between in-page links (by default)">Smooth Scroll between in-page links (by default)</a></li><li><a href=#scroll-to-top-button-by-default aria-label="Scroll-to-Top Button (by default)">Scroll-to-Top Button (by default)</a></li><li><a href=#google-analytics-integration aria-label="Google Analytics integration">Google Analytics integration</a></li><li><a href=#syntax-highlighting aria-label="Syntax highlighting">Syntax highlighting</a></li><li><a href=#rss-feeds aria-labeLine truncated
<span style=color:#75715e># defaultTheme: light</span>
<span style=color:#75715e># defaultTheme: dark</span>
<span style=color:#f92672>defaultTheme</span>: <span style=color:#ae81ff>auto</span> <span style=color:#75715e># to switch between dark or light according to browser theme</span>
</code></pre></div><hr><h3 id=theme-switch-toggle-enabled-by-default>Theme Switch Toggle (enabled by default)<a hidden class=anchor aria-hidden=true href=#theme-switch-toggle-enabled-by-default>#</a></h3><p>Shows icon besides title of page to change theme</p><p>To disable it :</p><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>disableThemeToggle</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><p>You can refer following table for better understanding&mldr;</p><table><thead><tr><th><code>defaultTheme</code></th><th><code>disableThemeToggle</code></th><th>checks local storage?</th><th>checks system theme?</th><th>Info</th></tr></thead><tbody><tr><td><code>auto</code></td><td>true</td><td>No</td><td>Yes</td><td>only system theme</td></tr><tr><td></td><td>false</td><td>Yes (if not->2)</td><td>Yes (2)</td><td><em>switch present</em></td></tr><tr><td><code>dark</code></td><td>true</td><td>No</td><td>No</td><td>force dark only</td></tr><tr><td></td><td>false</td><td>Yes</td><td>No</td><td><em>switch present</em></td></tr><tr><td><code>light</code></td><td>true</td><td>No</td><td>No</td><td>force light only</td></tr><tr><td></td><td>false</td><td>Yes</td><td>No</td><td><em>switch present</em></td></tr></tbody></table><hr><h3 id=archives-layout>Archives Layout<a hidden class=anchor aria-hidden=true href=#archives-layout>#</a></h3><p>Create a page with <code>archive.md</code> in <code>content</code> directory with following content</p><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;Archive&#34;</span> <span style=color:#75715e># in any language you want</span>
<span style=color:#f92672>layout</span>: <span style=color:#e6db74>&#34;archives&#34;</span> <span style=color:#75715e># is necessary</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;/archive&#34;</span>
<span style=color:#f92672>summary</span>: <span style=color:#e6db74>&#34;archive&#34;</span>
</code></pre></div><p>You can refer following table for better understanding&mldr;</p><table><thead><tr><th><code>defaultTheme</code></th><th><code>disableThemeToggle</code></th><th>checks local storage?</th><th>checks system theme?</th><th>Info</th></tr></thead><tbody><tr><td><code>auto</code></td><td>true</td><td>No</td><td>Yes</td><td>only system theme</td></tr><tr><td></td><td>false</td><td>Yes (if not->2)</td><td>Yes (2)</td><td><em>switch present</em></td></tr><tr><td><code>dark</code></td><td>true</td><td>No</td><td>No</td><td>force dark only</td></tr><tr><td></td><td>false</td><td>Yes</td><td>No</td><td><em>switch present</em></td></tr><tr><td><code>light</code></td><td>true</td><td>No</td><td>No</td><td>force light only</td></tr><tr><td></td><td>false</td><td>Yes</td><td>No</td><td><em>switch present</em></td></tr></tbody></table><hr><h3 id=archives-layout>Archives Layout<a hidden class=anchor aria-hidden=true href=#archives-layout>#</a></h3><p>Create a page with <code>archive.md</code> in <code>content</code> directory with following content</p><div class=highlight><pre style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-shell data-lang=shell>.
├── config.yml
├── content/
│ ├── archives.md &lt;--- Create archive.md here
│ └── posts/
├── static/
└── themes/
└── PaperMod/
</code></pre></div><p>and add the following to it</p><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;Archive&#34;</span>
<span style=color:#f92672>layout</span>: <span style=color:#e6db74>&#34;archives&#34;</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;/archives/&#34;</span>
<span style=color:#f92672>summary</span>: <span style=color:#ae81ff>archives</span>
---
</code></pre></div><p><strong>Note:</strong> Archives Layout does not support Multilingual Month Translations.</p><p>ex: <a href=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md>archives.md</a></p><hr><h3 id=regular-mode-default-mode>Regular Mode (default-mode)<a hidden class=anchor aria-hidden=true href=#regular-mode-default-mode>#</a></h3><p><img src=images/regular.jpg alt=regular></p><hr><h3 id=home-info-mode>Home-Info Mode<a hidden class=anchor aria-hidden=true href=#home-info-mode>#</a></h3><p><img src=images/homeinfo.jpg alt=homeinfo></p><p>Use 1st entry as some Information</p><p>add following to config file</p><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>params</span>:
@@ -21,7 +29,7 @@
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;&lt;link&gt;&#34;</span>
- <span style=color:#f92672>name</span>: <span style=color:#e6db74>&#34;&lt;platform 2&gt;&#34;</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;&lt;link2&gt;&#34;</span>
</code></pre></div><p>ex. <a href=https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106>config.yml#L106</a></p><hr><h3 id=profile-mode>Profile Mode<a hidden class=anchor aria-hidden=true href=#profile-mode>#</a></h3><p><img src=images/profile.jpg alt=profile></p><p>Shows Index/Home page as Full Page with Social Links and Image</p><p>add following to config file</p><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>params</span>:
</code></pre></div><p>ex. <a href=https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106>config.yml#L106</a></p><hr><h3 id=profile-mode>Profile Mode<a hidden class=anchor aria-hidden=true href=#profile-mode>#</a></h3><p><img src=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/posts/papermod/papermod-features/images/profile.jpg alt=profile></p><p>Shows Index/Home page as Full Page with Social Links and Image</p><p>add following to config file</p><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>params</span>:
<span style=color:#f92672>profileMode</span>:
<span style=color:#f92672>enabled</span>: <span style=color:#66d9ef>true</span>
<span style=color:#f92672>title</span>: <span style=color:#e6db74>&#34;&lt;Title&gt;&#34;</span> <span style=color:#75715e># optional default will be site title</span>
@@ -40,7 +48,7 @@
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;&lt;link&gt;&#34;</span>
- <span style=color:#f92672>name</span>: <span style=color:#e6db74>&#34;&lt;platform 2&gt;&#34;</span>
<span style=color:#f92672>url</span>: <span style=color:#e6db74>&#34;&lt;link2&gt;&#34;</span>
</code></pre></div><hr><h3 id=search>Search<a hidden class=anchor aria-hidden=true href=#search>#</a></h3><p>Add the following to site config, <code>config.yml</code></p><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>outputs</span>:
</code></pre></div><hr><h3 id=search>Search<a hidden class=anchor aria-hidden=true href=#search>#</a></h3><p>PaperMod uses <a href=https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds>Fuse.js Basic</a> for seach functionality</p><p>Add the following to site config, <code>config.yml</code></p><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>outputs</span>:
<span style=color:#f92672>home</span>:
- <span style=color:#ae81ff>HTML</span>
- <span style=color:#ae81ff>RSS</span>
@@ -49,10 +57,13 @@
<span style=color:#f92672>title</span>: <span style=color:#e6db74>&#34;Search&#34;</span> <span style=color:#75715e># in any language you want</span>
<span style=color:#f92672>layout</span>: <span style=color:#e6db74>&#34;search&#34;</span> <span style=color:#75715e># is necessary</span>
<span style=color:#75715e># url: &#34;/archive&#34;</span>
<span style=color:#75715e># description: &#34;Description for Search&#34;</span>
<span style=color:#f92672>summary</span>: <span style=color:#e6db74>&#34;search&#34;</span>
---
</code></pre></div><p>For Multilingual use <code>search.&lt;lang>.md</code> ex. <code>search.es.md</code>.</p><p><strong>Note:</strong> Search will work only on current language, user is currently on !</p><p><strong>Customizing Fusejs Options</strong></p><p>Refer <a href=https://fusejs.io/api/options.html>https://fusejs.io/api/options.html</a> for Options, Add those as shown below.</p><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>params</span>:
</code></pre></div><p>To hide a particular page from being searched, add it in post&rsquo;s fron&rsquo;t matter</p><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>searchHidden</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><p>ex: <a href=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md>search.md</a></p><p>For Multilingual use <code>search.&lt;lang>.md</code> ex. <code>search.es.md</code>.</p><p><strong>Note:</strong> Search will work only on current language, user is currently on !</p><p><strong>Customizing Fusejs Options</strong></p><p>Refer <a href=https://fusejs.io/api/options.html>https://fusejs.io/api/options.html</a> for Options, Add those as shown below.</p><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>params</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>
@@ -61,7 +72,7 @@
<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>]
</code></pre></div><p>ex: <a href=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md>search.md</a></p><hr><h3 id=draft-page-indication>Draft Page indication<a hidden class=anchor aria-hidden=true href=#draft-page-indication>#</a></h3><p>adds <code>[draft]</code> mark to indicate draft pages.</p><hr><h3 id=post-cover-image>Post Cover Image<a hidden class=anchor aria-hidden=true href=#post-cover-image>#</a></h3><p>In post&rsquo;s page-variables add :</p><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>cover</span>:
</code></pre></div><hr><h3 id=draft-page-indication>Draft Page indication<a hidden class=anchor aria-hidden=true href=#draft-page-indication>#</a></h3><p>adds <code>[draft]</code> mark to indicate draft pages.</p><hr><h3 id=post-cover-image>Post Cover Image<a hidden class=anchor aria-hidden=true href=#post-cover-image>#</a></h3><p>In post&rsquo;s page-variables add :</p><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>cover</span>:
<span style=color:#f92672>image</span>: <span style=color:#e6db74>&#34;&lt;image path/url&gt;&#34;</span>
<span style=color:#75715e># can also paste direct link from external site</span>
<span style=color:#75715e># ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png</span>
@@ -80,7 +91,15 @@
<span style=color:#f92672>ShowReadingTime</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><hr><h3 id=show-table-of-contents-toc-on-blog-post>Show Table of Contents (Toc) on blog post<a hidden class=anchor aria-hidden=true href=#show-table-of-contents-toc-on-blog-post>#</a></h3><p>Displays ToC on blog-pages</p><p>To show ToC add following to page-variables</p><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>ShowToc</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><p>To keep Toc Open <strong>by default</strong> on a post add following to page-variables:</p><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>TocOpen</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><hr><h3 id=multiple-authors>Multiple Authors<a hidden class=anchor aria-hidden=true href=#multiple-authors>#</a></h3><p>To Use multiple authors for a post, in post-variables:</p><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>---
</code></pre></div><hr><h3 id=breadcrumb-navigation>BreadCrumb Navigation<a hidden class=anchor aria-hidden=true href=#breadcrumb-navigation>#</a></h3><p>Adds BreadCrumb Navigation above Post&rsquo;s Title to show subsections and Navigation to Home</p><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>params</span>:
<span style=color:#f92672>ShowBreadCrumbs</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><p>Can be diabled for particular page&rsquo;s front-matter</p><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>ShowBreadCrumbs</span>: <span style=color:#66d9ef>false</span>
---
</code></pre></div><h3 id=other-posts-suggestion-below-a-post>Other Posts suggestion below a post<a hidden class=anchor aria-hidden=true href=#other-posts-suggestion-below-a-post>#</a></h3><p>Adds a Previous / Next post suggestion under a single post</p><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>params</span>:
<span style=color:#f92672>ShowPostNavLinks</span>: <span style=color:#66d9ef>true</span>
</code></pre></div><h3 id=multiple-authors>Multiple Authors<a hidden class=anchor aria-hidden=true href=#multiple-authors>#</a></h3><p>To Use multiple authors for a post, in post-variables:</p><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>author</span>: [<span style=color:#e6db74>&#34;Me&#34;</span>, <span style=color:#e6db74>&#34;You&#34;</span>]
---