<!doctype html><htmllang=endir=auto><head><metacharset=utf-8><metahttp-equiv=x-ua-compatiblecontent="IE=edge"><metaname=viewportcontent="width=device-width,initial-scale=1,shrink-to-fit=no"><metaname=robotscontent="index, follow"><title>Features | PaperMod</title><metaname=keywordscontent="PaperMod"><metaname=descriptioncontent="Get known about All Features in PaperMod"><metaname=authorcontent="Aditya Telange"><linkrel=canonicalhref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><linkhref=/hugo-PaperMod/assets/css/stylesheet.min.d85457619e67d31b97f40ed67c71b5efe0b52508ba759e5a9da0760afd6707db.cssintegrity="sha256-2FRXYZ5n0xuX9A7WfHG17+C1JQi6dZ5anaB2Cv1nB9s="rel="preload stylesheet"as=style><linkrel=iconhref=https://adityatelange.github.io/hugo-PaperMod/favicon.ico><linkrel=icontype=image/pngsizes=16x16href=https://adityatelange.github.io/hugo-PaperMod/favicon-16x16.png><linkrel=icontype=image/pngsizes=32x32href=https://adityatelange.github.io/hugo-PaperMod/favicon-32x32.png><linkrel=apple-touch-iconhref=https://adityatelange.github.io/hugo-PaperMod/apple-touch-icon.png><linkrel=mask-iconhref=https://adityatelange.github.io/hugo-PaperMod/safari-pinned-tab.svg><metaname=theme-colorcontent="#2e2e33"><metaname=msapplication-TileColorcontent="#2e2e33"><metaname=generatorcontent="Hugo 0.82.0"><linkrel=alternatehreflang=enhref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/><metaproperty="og:title"content="Features"><metaproperty="og:description"content="Get known about All Features in PaperMod"><metaproperty="og:type"content="article"><metaproperty="og:url"content="https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/"><metaproperty="og:image"content="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><metaproperty="article:section"content="posts"><metaproperty="article:published_time"content="2021-01-20T00:00:00+00:00"><metaproperty="article:modified_time"content="2021-01-20T00:00:00+00:00"><metaname=twitter:cardcontent="summary_large_image"><metaname=twitter:imagecontent="https://adityatelange.github.io/hugo-PaperMod/papermod-cover.png"><metaname=twitter:titlecontent="Features"><metaname=twitter:descriptioncontent="Get known about All Features in PaperMod"><scripttype=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Posts","item":"https://adityatelange.github.io/hugo-PaperMod/posts/"},{"@type":"ListItem","position":2,"name":"PaperMod","item":"https://adityatelange.github.io/hugo-PaperMod/posts/papermod/"},{"@type":"ListItem","position":3,"name":"Features","item":"https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/"}]}</script><scripttype=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","headline":"Features","name":"Features","description":"GetknownaboutAllFeaturesinPaperMod","keywords":["PaperMod"],"articleBody":"IntroWe’llbeusingyml/yamlformatforallexamplesdownbelow,Irecommendusingymlovertomlasitiseasiertoread.\nYoucanfindanyYMLtoTOMLconvertersifnecessary.\nAssets(js/css)Thefollowingisenabledbydefault\nminification-makestheassetssizesmallestaspossible.bundling-bundlesallthestylesinonesingleassetfingerprint/intergitycheck.DefaultThemelight/dark/autoparams:#defaultTheme:light#defaultTheme:darkdefaultTheme:auto#toswitchbetweendarkorlightaccordingtobrowserthemeThemeSwitchToggle(enabledbydefault)Showsiconbesidestitleofpagetochangetheme\nTodisableit:\ndisableThemeToggle:trueYoucanreferfollowingtableforbetterunderstanding…\ndefaultThemedisableThemeTogglecheckslocalstorage?checkssystemtheme?InfoautotrueNoYesonlysystemthemefalseYes(ifnot-2)Yes(2)switchpresentdarktrueNoNoforcedarkonlyfalseYesNoswitchpresentlighttrueNoNoforcelightonly
<spanclass=logo-switches><buttonid=theme-toggleaccesskey=ttitle="(Alt + T)"><svgid="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"><pathd="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg><svgid="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"><circlecx="12"cy="12"r="5"/><linex1="12"y1="1"x2="12"y2="3"/><linex1="12"y1="21"x2="12"y2="23"/><linex1="4.22"y1="4.22"x2="5.64"y2="5.64"/><linex1="18.36"y1="18.36"x2="19.78"y2="19.78"/><linex1="1"y1="12"x2="3"y2="12"/><linex1="21"y1="12"x2="23"y2="12"/><linex1="4.22"y1="19.78"x2="5.64"y2="18.36"/><linex1="18.36"y1="5.64"x2="19.78"y2="4.22"/></svg></button><ulclass=lang-switch><li>|</li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/fr/title=:fr:aria-label=:fr:>🇫🇷</a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/fa/title=Faaria-label=Fa>Fa</a></li></ul></span></div><ulid=menuonscroll=menu_on_scroll()><li><ahref=https://adityatelange.github.io/hugo-PaperMod/archivestitle=Archive><span>Archive</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/categories/title=Categories><span>Categories</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/search/title="Search (Alt + /)"accesskey=/><span>Search</span></a></li><li><ahref=https://adityatelange.github.io/hugo-PaperMod/tags/title=Tags><span>Tags</span></a></li></ul></nav></header><mainclass=main><articleclass=post-single><headerclass=post-header><divclass=breadcrumbs><ahref=https://adityatelange.github.io/hugo-PaperMod/>Home</a> » <ahref=https://adityatelange.github.io/hugo-PaperMod/posts/>Posts</a> » <ahref=https://adityatelange.github.io/hugo-PaperMod/posts/papermod/>PaperMod</a></div><h1class=post-title>Features</h1><divclass=post-meta>January 20, 2021 · 5 min · Aditya Telange</div></header><divclass=toc><details><summaryaccesskey=ctitle="(Alt + C)"><divclass=details>Table of Contents</div></summary><divclass=inner><ul><li><ahref=#introaria-label=Intro>Intro</a></li><li><ahref=#assets-jscssaria-label="Assets (js/css)">Assets (js/css)</a></li><li><ahref=#default-theme-lightdarkautoaria-label="Default Theme light/dark/auto">Default Theme light/dark/auto</a></li><li><ahref=#theme-switch-toggle-enabled-by-defaultaria-label="Theme Switch Toggle (enabled by default)">Theme Switch Toggle (enabled by default)</a></li><li><ahref=#archives-layoutaria-label="Archives Layout">Archives Layout</a></li><li><ahref=#regular-mode-default-modearia-label="Regular Mode (default-mode)">Regular Mode (default-mode)</a></li><li><ahref=#home-info-modearia-label="Home-Info Mode">Home-Info Mode</a></li><li><ahref=#profile-modearia-label="Profile Mode">Profile Mode</a></li><li><ahref=#search-pagearia-label="Search Page">Search Page</a></li><li><ahref=#draft-page-indicationaria-label="Draft Page indication">Draft Page indication</a></li><li><ahref=#post-cover-imagearia-label="Post Cover Image">Post Cover Image</a></li><li><ahref=#share-buttons-on-postaria-label="Share Buttons on post">Share Buttons on post</a></li><li><ahref=#show-post-reading-timearia-label="Show post reading time">Show post reading time</a></li><li><ahref=#show-table-of-contents-toc-on-blog-postaria-label="Show Table of Contents (Toc) on blog post">Show Table of Contents (Toc) on blog post</a></li><li><ahref=#breadcrumb-navigationaria-label="BreadCrumb Navigation">BreadCrumb Navigation</a></li><li><ahref=#edit-link-for-postsaria-label="Edit Link for Posts">Edit Link for Posts</a></li><li><ahref=#other-posts-suggestion-below-a-postaria-label="Other Posts suggestion below a post">Other Posts suggestion below a post</a></li><li><ahref=#multiple-authorsaria-label="Multiple Authors">Multiple Authors</a></li><li>
<spanstyle=color:#f92672>defaultTheme</span>: <spanstyle=color:#ae81ff>auto</span><spanstyle=color:#75715e># to switch between dark or light according to browser theme</span>
</code></pre></div></details><hr><h3id=theme-switch-toggle-enabled-by-default>Theme Switch Toggle (enabled by default)<ahiddenclass=anchoraria-hidden=truehref=#theme-switch-toggle-enabled-by-default>#</a></h3><p>Shows icon besides title of page to change theme</p><p>To disable it :</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>disableThemeToggle</span>: <spanstyle=color:#66d9ef>true</span>
</code></pre></div><p>You can refer following table for better understanding…</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><h3id=archives-layout>Archives Layout<ahiddenclass=anchoraria-hidden=truehref=#archives-layout>#</a></h3><p>Create a page with <code>archive.md</code> in <code>content</code> directory with following content</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-shelldata-lang=shell>.
├── config.yml
├── content/
│ ├── archives.md <--- Create archive.md here
│ └── posts/
├── static/
└── themes/
└── PaperMod/
</code></pre></div><p>and add the following to it</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
</code></pre></div><p><strong>Note:</strong> Archives Layout does not support Multilingual Month Translations.</p><p>ex: <ahref=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md>archives.md</a></p><hr><h3id=regular-mode-default-mode>Regular Mode (default-mode)<ahiddenclass=anchoraria-hidden=truehref=#regular-mode-default-mode>#</a></h3><p><imgloading=lazysrc=images/regular.jpgalt=regular></p><hr><h3id=home-info-mode>Home-Info Mode<ahiddenclass=anchoraria-hidden=truehref=#home-info-mode>#</a></h3><p><imgloading=lazysrc=images/homeinfo.jpgalt=homeinfo></p><p>Use 1st entry as some Information</p><p>add following to config file</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><p>ex. <ahref=https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106>config.yml#L106</a></p><hr><h3id=profile-mode>Profile Mode<ahiddenclass=anchoraria-hidden=truehref=#profile-mode>#</a></h3><p><imgloading=lazysrc=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/posts/papermod/papermod-features/images/profile.jpgalt=profile></p><p>Shows Index/Home page as Full Page with Social Links and Image</p><p>add following to config file</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
<spanstyle=color:#f92672>title</span>: <spanstyle=color:#e6db74>"<Title>"</span><spanstyle=color:#75715e># optional default will be site title</span>
<spanstyle=color:#f92672>imageTitle</span>: <spanstyle=color:#e6db74>"<title of image as alt>"</span><spanstyle=color:#75715e># optional</span>
</code></pre></div><hr><h3id=search-page>Search Page<ahiddenclass=anchoraria-hidden=truehref=#search-page>#</a></h3><p>PaperMod uses <ahref=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><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>outputs</span>:
- <spanstyle=color:#ae81ff>JSON</span><spanstyle=color:#75715e># is necessary</span>
</code></pre></div><p>Create a page with <code>search.md</code> in <code>content</code> directory with following content</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
<spanstyle=color:#f92672>title</span>: <spanstyle=color:#e6db74>"Search"</span><spanstyle=color:#75715e># in any language you want</span>
<spanstyle=color:#f92672>layout</span>: <spanstyle=color:#e6db74>"search"</span><spanstyle=color:#75715e># is necessary</span>
</code></pre></div><p>To hide a particular page from being searched, add it in post’s fron’t matter</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
</code></pre></div><p>ex: <ahref=https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md>search.md</a></p><blockquote><p>Search Page also has Key bindings:</p><ul><li>Arrow keys to move up/down the list</li><li>Enter key (return) or Right Arrow key to Go to highlighted page</li><li>Escape key to clear searchbox and results</li></ul></blockquote><p>For Multilingual use <code>search.<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 <ahref=https://fusejs.io/api/options.html>https://fusejs.io/api/options.html</a> for Options, Add those as shown below.</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
<spanstyle=color:#f92672>relative</span>: <spanstyle=color:#66d9ef>false</span><spanstyle=color:#75715e># To use relative path for cover image, used in hugo Page-bundles</span>
</code></pre></div><p>When you include images in the <ahref=https://gohugo.io/content-management/page-bundles/>Page Bundle</a>, multiple sizes of the image will automatically be provided using the HTML5 <code>srcset</code> field.</p><p>To reduce generation time and size of the site, you can disable this feature using</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><p>To enable hyperlinks to the full image size on post pages, use</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><hr><h3id=share-buttons-on-post>Share Buttons on post<ahiddenclass=anchoraria-hidden=truehref=#share-buttons-on-post>#</a></h3><p>Displays Share Buttons at Bottom of each post</p><p>to show share buttons add</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><hr><h3id=show-post-reading-time>Show post reading time<ahiddenclass=anchoraria-hidden=truehref=#show-post-reading-time>#</a></h3><p>Displays Reading Time (the estimated time, in minutes, it takes to read the content.)</p><p>To show reading time add</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>Params</span>:
</code></pre></div><hr><h3id=show-table-of-contents-toc-on-blog-post>Show Table of Contents (Toc) on blog post<ahiddenclass=anchoraria-hidden=truehref=#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><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>ShowToc</span>: <spanstyle=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><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>TocOpen</span>: <spanstyle=color:#66d9ef>true</span>
</code></pre></div><hr><h3id=breadcrumb-navigation>BreadCrumb Navigation<ahiddenclass=anchoraria-hidden=truehref=#breadcrumb-navigation>#</a></h3><p>Adds BreadCrumb Navigation above Post’s Title to show subsections and Navigation to Home</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><p>Can be diabled for particular page’s front-matter</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
</code></pre></div><hr><h3id=edit-link-for-posts>Edit Link for Posts<ahiddenclass=anchoraria-hidden=truehref=#edit-link-for-posts>#</a></h3><p>Add a button to suggest changes by using the file path of the post to link to a edit destination.</p><p>For site config use:</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>Params</span>:
<spanstyle=color:#f92672>appendFilePath</span>: <spanstyle=color:#66d9ef>true</span><spanstyle=color:#75715e># to append file path to Edit link</span>
</code></pre></div><p>Can be modified for individual pages</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
<spanstyle=color:#f92672>appendFilePath</span>: <spanstyle=color:#66d9ef>true</span><spanstyle=color:#75715e># to append file path to Edit link</span>
---
</code></pre></div><p>The example above would yield the following link for the post file <code>posts/post-name.md</code>:
<ahref=https://github.com/>https://github.com/</a><path_to_repo>/content/posts/post-name.md</p><table><thead><tr><th>Parameter</th><th>Required</th><th>Default Value</th></tr></thead><tbody><tr><td>editPost.URL</td><td>true</td><td>-</td></tr><tr><td>editPost.appendFilePath</td><td>false</td><td>false</td></tr><tr><td>editPost.Text</td><td>false</td><td>“Edit”</td></tr></tbody></table><p>Since the link generated is a regular HTML anchor tag <code><a href=...></code>, you can
also use other URL schemas like <code>mailto://</code>, e.g.
<code>URL: "mailto://mail@example.com?subject=Suggesting changes for "</code></p><hr><h3id=other-posts-suggestion-below-a-post>Other Posts suggestion below a post<ahiddenclass=anchoraria-hidden=truehref=#other-posts-suggestion-below-a-post>#</a></h3><p>Adds a Previous / Next post suggestion under a single post</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><hr><h3id=multiple-authors>Multiple Authors<ahiddenclass=anchoraria-hidden=truehref=#multiple-authors>#</a></h3><p>To Use multiple authors for a post, in post-variables:</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml>---
</code></pre></div><p>To use Multiple Authors Site-wide, in <code>config.yml</code>:</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><hr><h3id=comments>Comments<ahiddenclass=anchoraria-hidden=truehref=#comments>#</a></h3><p>to add comments, create a html file</p><p><code>layouts/partials/comments.html</code></p><p>and paste code provided by your comments provider</p><p>also in config add this</p><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-ymldata-lang=yml><spanstyle=color:#f92672>params</span>:
</code></pre></div><p>read more about this <ahref=https://gohugo.io/content-management/comments/>hugo-comments</a></p><hr><h3id=accesskeys>AccessKeys<ahiddenclass=anchoraria-hidden=truehref=#accesskeys>#</a></h3><divclass=highlight><prestyle=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-textdata-lang=text>c - ToC Open/Close
<span>Theme <ahref=https://git.io/hugopapermodrel=noopenertarget=_blank>PaperMod</a></span></footer><ahref=#toparia-label="go to top"title="Go to Top (Alt + G)"><buttonclass=top-linkid=top-linktype=buttonaccesskey=g><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 12 6"fill="currentcolor"><pathd="M12 6H0l6-6z"/></svg></button></a>
