revamp 🌟

[WIP] prepare for 4.0 release

content/posts/papermod/papermod-installation.md

@@ -1,5 +1,5 @@
 ---
-title: "Papermod - Installation"
+title: "Installation | Update"
 summary: Read Install and Update instructions here
 date: 2020-09-15T11:30:03+05:30
 series: ["PaperMod"]
@@ -13,48 +13,76 @@ TocOpen: true
 
 ## Guide
 
-Follow [this](https://gohugo.io/getting-started/quick-start/) guide to setup hugo and create a new site.
-Make sure you install latest version of `hugo`(>=0.74.0).
+Follow [Quick Start](https://gohugo.io/getting-started/quick-start/) guide to setup hugo and create a new site.
+Make sure you install latest version of **`hugo(>=0.74.0)`**.
 
 After you have created a new site, at [Step 3](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) follow the steps:
 
+### Method 1
+
 Inside the folder of your Hugo site, run:
 
-> ```console
-> git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1
-> ```
->
-> > Updating theme :
-> >
-> > ```console
-> > cd themes/hugo-PaperMod
-> > git pull
-> > ```
-
-**or** you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with
-
-> ```console
-> git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod
-> git submodule update --init --recursive
-> ```
->
-> > Updating theme with submodule :
-> >
-> > ```console
-> > git submodule update --remote --merge
-> > ```
-> >
-> > Then change in `config.yml`:
-
-```yml
-theme: "hugo-PaperMod"
+```bash
+git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1
 ```
 
-Example Site Structure is present here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/)
+**Note**: You may use ` --branch v3.0` to end of above command if you want to stick to specific release.
+
+> Updating theme :
+>
+> ```bash
+> cd themes/PaperMod
+> git pull
+> ```
+
+### Method 2
+
+you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with
+
+```bash
+git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1
+git submodule update --init --recursive
+```
+
+**Note**: You may use ` --branch v3.0` to end of above command if you want to stick to specific release.
+
+> Updating theme :
+>
+> ```bash
+> git submodule update --remote --merge
+> ```
+
+### Method 3
+
+Or you can Download as Zip from Github Page and extract in your themes directory
+
+### Finally ...
+
+Add in `config.yml`:
+
+```yml
+theme: "PaperMod"
+```
 
 ---
 
-### Sample `config.yml`
+## Quick Links
+
+-   ### [Papermod - Features](../papermod-features)
+
+-   ### [Papermod - How to Guide](../papermod-how-to)
+
+-   ### [Papermod - Icons](../papermod-icons)
+
+-   ### [ChangeLog](https://github.com/adityatelange/hugo-PaperMod/releases)
+
+---
+
+## Sample `config.yml`
+
+> **Example Site Structure is present here**: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/)
+
+**Use appropriately**
 
 ```yml
 baseURL: "https://examplesite.com"
@@ -90,6 +118,8 @@ params:
     disableSpecial1stPost: false
 
     assets:
+        # disableHLJS: true # to disable highlightjs
+        # disableFingerprinting: true
         favicon: "<link / abs url>"
         favicon16x16: "<link / abs url>"
         favicon32x32: "<link / abs url>"
@@ -105,8 +135,10 @@ params:
     profileMode:
         enabled: false # needs to be explicitly set
         title: ExampleSite
-        # imageUrl: '<img location>'
-        # imageTitle: my image
+        imageUrl: "<img location>"
+        imageWidth: 120
+        imageHeight: 120
+        imageTitle: my image
         buttons:
             - name: Posts
               url: posts
@@ -130,6 +162,21 @@ params:
         google:
             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
+
+    # 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
@@ -148,7 +195,7 @@ menu:
 
 ---
 
-### Sample `Page.md`
+## Sample `Page.md`
 
 ```yml
 ---
@@ -165,19 +212,16 @@ draft: false
 hidemeta: false
 disableShare: false
 cover:
-    image: "<image path/url>"
-    alt: "<alt text>"
-    caption: "<text>"
-    relative: false
+    image: "<image path/url>" # image path/url
+    alt: "<alt text>" # alt text
+    caption: "<text>" # display caption under cover
+    relative: false # when using page bundles set this to true
+    hidden: true # only hide on current single page
 comments: false
+description: "Desc Text."
+disableHLJS: true # to disable highlightjs
 ---
 
 ```
 
 ---
-
-### [Papermod - Features](../papermod-features)
-
-### [Papermod - How to Guide](../papermod-how-to)
-
-### [Papermod - Icons](../papermod-icons)