• We’ll be using yml/yaml format for all examples down below, it is recommend to use yaml over toml as it is easier to read.
  • You can find any YML to TOML converters if needed.

Getting Started 🚀

  1. Follow Hugo Docs’s - Quick Start guide to install .
    (Make sure you install Hugo v0.146.0 + 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 site

    hugo new site MyFreshWebsite --format yaml
# replace MyFreshWebsite with name of your website

    Note:

  3. Installing/Updating PaperMod

    • Themes reside in MyFreshWebsite/themes directory.
    • PaperMod will be installed in MyFreshWebsite/themes/PaperMod

    Expand Method 1 - Git Clone

    INSTALL : Inside the folder of your Hugo site MyFreshWebsite, run:

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

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

    UPDATE: Inside the folder of your Hugo site MyFreshWebsite, run:

    cd themes/PaperMod
git pull

    Expand Method 2 - Git Submodule (recomended)

    INSTALL : Inside the folder of your Hugo site MyFreshWebsite, run:

    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)

    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.

    UPDATE: Inside the folder of your Hugo site MyFreshWebsite, run:

    git submodule update --remote --merge

    Expand Method 3 - Download an unzip

    Download PaperMod source as Zip from Github Releases and extract in your themes directory at MyFreshWebsite/themes/PaperMod

    Direct Links:

    Expand Method 4 - Hugo module

    INSTALL :

    hugo mod init YOUR_OWN_GIT_REPOSITORY
    • Add PaperMod in your hugo.yaml file
    1
2
3

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

    UPDATE:

    hugo mod get -u

    Read more : Hugo Docs’s - HUGO MODULES

  4. Finally set theme as PaperMod in your site config

    In hugo.yaml add:

    1

    theme: ["PaperMod"]

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
  • You can also refer to the following wiki pages for detailed documentation on all features and configuration options.
Topic Description
Installation guide Detailed installation and update instructions
Features wiki page In-depth explanations of all features
FAQ wiki Common questions and configuration walkthroughs
Icons wiki Documentation for social icons and share icons
Variables wiki List of all available template variables
Overiding templates Guide to customizing templates without forking
Releases Detailed history of releases

Support 🫶

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.

▶️ Curated list of videos about PaperMod