From 0cb2264ad3601408c0b9a832a0911c9f086ddfb7 Mon Sep 17 00:00:00 2001
From: Aditya Telange <21258296+adityatelange@users.noreply.github.com>
Date: Sat, 9 May 2026 21:31:46 +0530
Subject: [PATCH] docs(papermod): update installation guide with clearer
instructions
---
.../posts/papermod/papermod-installation.md | 384 ++++--------------
1 file changed, 87 insertions(+), 297 deletions(-)
diff --git a/content/posts/papermod/papermod-installation.md b/content/posts/papermod/papermod-installation.md
index b5d7e9b9..51c351da 100644
--- a/content/posts/papermod/papermod-installation.md
+++ b/content/posts/papermod/papermod-installation.md
@@ -1,15 +1,13 @@
---
-title: "Install / Update PaperMod"
-summary: Read aboout Install and Update instructions and sampled configuration templates
+title: "PaperMod Installation Guide"
+summary: "Step by step guide to install and update PaperMod in your Hugo site."
date: 2021-01-20
weight: 1
series: ["PaperMod"]
aliases: ["/papermod-installation"]
tags: ["PaperMod", "Docs"]
author: ["Aditya Telange"]
-cover:
- image: images/papermod-cover.png
- hiddenInList: true
+
social:
fediverse_creator: "@adityatelange@mastodon.social"
---
@@ -21,132 +19,138 @@ social:
## Getting Started 🚀
-1. Follow **[Hugo Docs's - Quick Start](https://gohugo.io/getting-started/quick-start/)** guide to install {{< inTextImg url="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/static/img/hugo-logo.png" height="14" >}}.
- (Make sure you install **Hugo >= v0.112.4**)
+1. **Follow [Hugo Docs's - Quick Start](https://gohugo.io/getting-started/quick-start/) guide to install {{< inTextImg url="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/static/img/hugo-logo.png" height="14" >}}.**
+ (Make sure you install [**Hugo v0.146.0 +**](https://github.com/gohugoio/hugo/releases) as PaperMod uses some of the latest features of Hugo. You can check your Hugo version by running `hugo version` in terminal.)
+
+2. **Create a new {{< inTextImg url="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/static/img/hugo-logo.png" height="14" >}} site**
-2. Create a new {{< inTextImg url="https://raw.githubusercontent.com/gohugoio/hugoDocs/master/static/img/hugo-logo.png" height="14" >}} site
```sh
hugo new site MyFreshWebsite --format yaml
# replace MyFreshWebsite with name of your website
```
+
Note:
- Older versions of Hugo may not support `--format yaml`
- Read more here about [Hugo Docs's - hugo new site command](https://gohugo.io/commands/hugo_new_site/#synopsis)
-After you have created a new site, follow the below steps to add **PaperMod**
+3. **Installing/Updating PaperMod**
+ - Themes reside in `MyFreshWebsite/themes` directory.
+ - PaperMod will be installed in `MyFreshWebsite/themes/PaperMod`
-### Installing/Updating PaperMod
+ > {{< collapse summary="**Expand Method 1 - Git Clone**" >}}
-- Themes reside in `MyFreshWebsite/themes` directory.
-- PaperMod will be installed in `MyFreshWebsite/themes/PaperMod`
+ **INSTALL** : Inside the folder of your Hugo site `MyFreshWebsite`, run:
-> {{< collapse summary="**Expand Method 1 - Git Clone**" >}}
+ ```bash
+ git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1
+ ```
-**INSTALL** : Inside the folder of your Hugo site `MyFreshWebsite`, run:
+ You may use ` --branch v7.0` to end of above command if you want to stick to specific release.
-```bash
-git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1
-```
+ **UPDATE**: Inside the folder of your Hugo site `MyFreshWebsite`, run:
-You may use ` --branch v7.0` to end of above command if you want to stick to specific release.
+ ```bash
+ cd themes/PaperMod
+ git pull
+ ```
-**UPDATE**: Inside the folder of your Hugo site `MyFreshWebsite`, run:
+ {{}}
-```bash
-cd themes/PaperMod
-git pull
-```
+ > {{< collapse summary="**Expand Method 2 - Git Submodule (recomended)**" >}}
-{{}}
+ **INSTALL** : Inside the folder of your Hugo site `MyFreshWebsite`, run:
-> {{< collapse summary="**Expand Method 2 - Git Submodule (recomended)**" >}}
+ ```bash
+ git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod
+ git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically)
+ ```
-**INSTALL** : Inside the folder of your Hugo site `MyFreshWebsite`, run:
+ You may use ` --branch v7.0` to end of above command if you want to stick to specific release.
+ Read more about git submodules [here](https://www.atlassian.com/git/tutorials/git-submodule).
-```bash
-git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod
-git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically)
-```
+ **UPDATE**: Inside the folder of your Hugo site `MyFreshWebsite`, run:
-You may use ` --branch v7.0` to end of above command if you want to stick to specific release.
-Read more about git submodules [here](https://www.atlassian.com/git/tutorials/git-submodule).
+ ```bash
+ git submodule update --remote --merge
+ ```
-**UPDATE**: Inside the folder of your Hugo site `MyFreshWebsite`, run:
+ {{}}
-```bash
-git submodule update --remote --merge
-```
+ > {{< collapse summary="**Expand Method 3 - Download an unzip**" >}}
-{{}}
+ Download PaperMod source as Zip from Github Releases and extract in your themes directory at `MyFreshWebsite/themes/PaperMod`
-> {{< collapse summary="**Expand Method 3 - Download an unzip**" >}}
+ Direct Links:
+ - [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip)
+ - [v7.0](https://github.com/adityatelange/hugo-PaperMod/archive/v7.0.zip)
+ - [v6.0](https://github.com/adityatelange/hugo-PaperMod/archive/v6.0.zip)
+ - [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip)
+ - [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip)
+ - [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
+ - [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
+ - [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip)
-Download PaperMod source as Zip from Github Releases and extract in your themes directory at `MyFreshWebsite/themes/PaperMod`
+ {{}}
-Direct Links:
+ > {{< collapse summary="**Expand Method 4 - Hugo module**" >}}
-- [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip)
-- [v7.0](https://github.com/adityatelange/hugo-PaperMod/archive/v7.0.zip)
-- [v6.0](https://github.com/adityatelange/hugo-PaperMod/archive/v6.0.zip)
-- [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip)
-- [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip)
-- [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
-- [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
-- [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip)
+ **INSTALL** :
+ - Install [Go programming language](https://go.dev/doc/install) in your operating system.
-{{}}
+ - Intialize your own hugo mod
-> {{< collapse summary="**Expand Method 4 - Hugo module**" >}}
+ ```
+ hugo mod init YOUR_OWN_GIT_REPOSITORY
+ ```
-**INSTALL** :
+ - Add PaperMod in your `hugo.yaml` file
-- Install [Go programming language](https://go.dev/doc/install) in your operating system.
+ ```go {linenos=true}
+ module:
+ imports:
+ - path: github.com/adityatelange/hugo-PaperMod
+ ```
-- Intialize your own hugo mod
+ **UPDATE**:
-```
-hugo mod init YOUR_OWN_GIT_REPOSITORY
-```
+ ```
+ hugo mod get -u
+ ```
-- Add PaperMod in your `hugo.yaml` file
+ Read more : [Hugo Docs's - HUGO MODULES](https://gohugo.io/hugo-modules/use-modules/)
-```go {linenos=true}
-module:
- imports:
- - path: github.com/adityatelange/hugo-PaperMod
-```
+ {{}}
-**UPDATE**:
+4. **Finally set theme as PaperMod in your site config**
-```
-hugo mod get -u
-```
+ In `hugo.yaml` add:
-Read more : [Hugo Docs's - HUGO MODULES](https://gohugo.io/hugo-modules/use-modules/)
+ ```yml {linenos=true}
+ theme: ["PaperMod"]
+ ```
-{{}}
-
-### Finally set theme as PaperMod in your site config
-
-In `hugo.yaml` add:
-
-```yml {linenos=true}
-theme: ["PaperMod"]
-```
-
-### Next up - Customizing PaperMod to suit your preferences.
+### Next up - Customizing PaperMod to suit your preferences 🎨
- Your site will be blank after you set up for the very first time.
- You may go through this website's source code - [PaperMod's exampleSite's source](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite)
-- Scroll below this page where you will find more specific details about each section.
-- Kindly go through all of the pages below to know how to configure PaperMod.
+- You can also refer to the following wiki pages for detailed documentation on all features and configuration options.
+
+| Topic | Description |
+| ------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| **[Installation guide](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)** | Detailed installation and update instructions |
+| **[Features wiki page](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)** | In-depth explanations of all features |
+| **[FAQ wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** | Common questions and configuration walkthroughs |
+| **[Icons wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** | Documentation for social icons and share icons |
+| **[Variables wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Variables)** | List of all available template variables |
+| **[Overiding templates](https://github.com/adityatelange/hugo-PaperMod/wiki/Template_Overrides)** | Guide to customizing templates without forking |
+| **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** | Detailed history of releases |
---
## Support 🫶
-- Star 🌟 PaperMod's Github repository.
-- Help spread the word about PaperMod by sharing it on social media and recommending it to your friends. 🗣️
+- Star 🌟 PaperMod's [Github repository](https://github.com/adityatelange/hugo-PaperMod).
+- Help spread the word about PaperMod by [sharing it on social media](https://x.com/intent/tweet/?text=Checkout%20Hugo%20PaperMod%20%E2%9C%A8%0AA%20fast,%20clean,%20responsive%20Hugo%20theme.&url=https://github.com/adityatelange/hugo-PaperMod&hashtags=Hugo,PaperMod) and recommending it to your friends. 🗣️
- You can also sponsor 🏅 on [Github Sponsors](https://github.com/sponsors/adityatelange) / [Ko-Fi](https://ko-fi.com/adityatelange).
---
@@ -155,220 +159,6 @@ theme: ["PaperMod"]
You can go through few videos which are available on YouTube for getting to know the creator's thoughts as well as the setup process.
-▶️ https://youtube.com/playlist?list=PLeiDFxcsdhUrzkK5Jg9IZyiTsIMvXxKZP
-
----
-
-## Quick Links
-
-- ### [Papermod - Features](../papermod-features)
-
-- ### [Papermod - FAQs](../papermod-how-to)
-
-- ### [Papermod - Variables](../papermod-variables)
-
-- ### [Papermod - Icons](../papermod-icons)
-
-- ### [ChangeLog](https://github.com/adityatelange/hugo-PaperMod/releases)
-
----
-
-## Sample `hugo.yaml`
-
-> **Example Site Structure is present here**: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/)
-
-**Use appropriately**
-
-```yml
-baseURL: "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
- ShowWordCount: true
- ShowRssButtonInSectionTermList: true
- UseHugoToc: true
- 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: x
- url: "https://x.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
- limit: 10 # refer: https://www.fusejs.io/api/methods.html#search
- 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:
- noClasses: false
- # anchorLineNos: true
- # codeFences: true
- # guessSyntax: true
- # lineNos: true
- # style: monokai
-```
-
----
-
-## Sample `Page.md`
-
-```yml
----
-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
-ShowWordCount: true
-ShowRssButtonInSectionTermList: true
-UseHugoToc: 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`
-
-```shell
-hugo new --kind post
-```
+▶️ [Curated list of videos about PaperMod](https://youtube.com/playlist?list=PLeiDFxcsdhUrzkK5Jg9IZyiTsIMvXxKZP)
---