23 Installation

Aditya Telange edited this page 2023-11-26 13:15:50 +05:30

Table of Contents

• ToC
• Intro
• Guide
• Method 1
• Method 2
• Method 3
• Finally ...
• Additional Method (by #701)
• Videos featuring Papermod
• Quick Links
• Features
• Icons
• FAQs
• Variables
• Translations
• ChangeLog
• Sample config.yml
• Sample Page.md

ToC

• Guide
  • Method 1
  • Method 2
  • Method 3
  • Finally ...
• Videos featuring Papermod
• Sample config.yml
• Sample Page.md

---

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.
• You can find any YML to TOML converters if necessary.

---

Guide

Follow Quick Start guide to setup hugo and create a new site.

Prerequisites

• Install Hugo - Make sure you install latest version of hugo(>=0.83.0).
• Install Git - necessary for Method 1 & 2.

Create a new site

• hugo new site <name of site> --format yaml
• cd <name of site>

After you have created a new site, follow the below steps:

Method 1

Inside the folder of your Hugo site, run:

git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1

Note: You may use --branch v7.0 to end of above command if you want to stick to specific release.

Updating theme with Method 1 :

cd themes/PaperMod
git pull

Method 2

you can use as submodule with

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)

Note: You may use --branch v7.0 to end of above command if you want to stick to specific release.

Updating theme with Method 2 :

git submodule update --remote --merge

Method 3

You can Download as Zip from Github Page and extract in your themes directory

Direct Links:

• Master Branch (Latest)
• v7.0
• v6.0
• v5.0
• v4.0
• v3.0
• v2.0
• v1.0

Updating theme with Method 3 :

• Download the version you wish to upgrade to and extract the new version in your themes directory at themes/PaperMod.
• ex. v6.0 is already installed, v7.0 should be downloaded using above links and extract the new version in your themes directory at themes/PaperMod

Finally ...

Add in config.yml:

theme: "PaperMod"

Additional Method (by #701)

• Install Go programming language in your operating system.
• Intialize your own hugo mod

• hugo mod init YOUR_OWN_GIT_REPOSITORY`
  

• Add PaperMod in your config.yml file

• module:
    imports:
      - path: github.com/adityatelange/hugo-PaperMod
  

Updating theme :

hugo mod get -u

---

Videos featuring 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

• Features

• Icons

• FAQs

• Variables

• Translations

• ChangeLog

---

Sample config.yml

Example Site Structure is present here: exampleSite

Use appropriately

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: ["<link or path of image for opengraph, twitter-cards>"]
  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: "<link / abs url>"
    favicon16x16: "<link / abs url>"
    favicon32x32: "<link / abs url>"
    apple_touch_icon: "<link / abs url>"
    safari_pinned_tab: "<link / abs url>"

  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: "<img location>"
    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: twitter
      url: "https://twitter.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/<path_to_repo>/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
    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

---
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>" # 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
editPost:
    URL: "https://github.com/<path_to_repo>/content"
    Text: "Suggest Changes" # edit text
    appendFilePath: true # to append file path to Edit link
---

You can use it by creating archetypes/posts.md

hugo new --kind post <name>

---

Go-To-Top 🔝