Skip to content


Aditya Telange edited this page Aug 19, 2022 · 13 revisions


View demo here


  • 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.

Assets (js/css)

The following is enabled by default

Default Theme light/dark/auto

    # defaultTheme: light
    # defaultTheme: dark
    defaultTheme: auto # to switch between dark or light according to browser theme

Theme Switch Toggle (enabled by default)

Shows icon besides title of page to change theme

To disable it :

disableThemeToggle: true

You can refer following table for better understanding...

defaultTheme disableThemeToggle checks local storage? checks system theme? Info
auto true No Yes only system theme
false Yes (if not->2) Yes (2) switch present
dark true No No force dark only
false Yes No switch present
light true No No force light only
false Yes No switch present

Archives Layout

Create a page with in content directory with following content

├── config.yml
├── content/
│   ├──   <--- Create here
│   └── posts/
├── static/
└── themes/
    └── PaperMod/

and add the following to it

title: "Archive"
layout: "archives"
url: "/archives/"
summary: archives

Note: Archives Layout does not support Multilingual Month Translations.


Regular Mode (default-mode)


Home-Info Mode


Use 1st entry as some Information

add following to config file

        Title: Hi there wave
        Content: Can be Info, links, about...

    socialIcons: # optional
        - name: "<platform>"
            url: "<link>"
        - name: "<platform 2>"
            url: "<link2>"

Profile Mode


Shows Index/Home page as Full Page with Social Links and Image

add following to config file

        enabled: true
        title: "<Title>" # optional default will be site title
        subtitle: "This is subtitle"
        imageUrl: "<image link>" # optional
        imageTitle: "<title of image as alt>" # optional
        imageWidth: 120 # custom size
        imageHeight: 120 # custom size
            - name: Archive
            url: "/archive"
            - name: Github
            url: ""

    socialIcons: # optional
        - name: "<platform>"
            url: "<link>"
        - name: "<platform 2>"
            url: "<link2>"

Search Page

PaperMod uses Fuse.js Basic for seach functionality

Add the following to site config, config.yml

        - HTML
        - RSS
        - JSON # is necessary

Create a page with in content directory with following content

title: "Search" # in any language you want
layout: "search" # is necessary
# url: "/archive"
# description: "Description for Search"
summary: "search"
placeholder: "placeholder text in search input box"

To hide a particular page from being searched, add it in post's fron't matter

searchHidden: true


Search Page also has Key bindings:

  • Arrow keys to move up/down the list
  • Enter key (return) or Right Arrow key to Go to highlighted page
  • Escape key to clear searchbox and results

For Multilingual use search.<lang>.md ex.

Note: Search will work only on current language, user is currently on !

Customizing Fusejs Options

Refer for Options, Add those as shown below.

        isCaseSensitive: false
        shouldSort: true
        location: 0
        distance: 1000
        threshold: 0.4
        minMatchCharLength: 0
        keys: ["title", "permalink", "summary", "content"]

Draft Page indication

adds [draft] mark to indicate draft pages.

Post Cover Image

In post's page-variables add :

    image: "<image path/url>"
    # can also paste direct link from external site
    # ex.
    alt: "<alt text>"
    caption: "<text>"
    relative: false # To use relative path for cover image, used in hugo Page-bundles

When you include images in the Page Bundle, multiple sizes of the image will automatically be provided using the HTML5 srcset field.

To reduce generation time and size of the site, you can disable this feature using

        responsiveImages: false

To enable hyperlinks to the full image size on post pages, use

        linkFullImages: true

Share Buttons on post

Displays Share Buttons at Bottom of each post

to show share buttons add

    ShowShareButtons: true

Show post reading time

Displays Reading Time (the estimated time, in minutes, it takes to read the content.)

To show reading time add

    ShowReadingTime: true

Show Table of Contents (Toc) on blog post

Displays ToC on blog-pages

To show ToC add following to page-variables

ShowToc: true

To keep Toc Open by default on a post add following to page-variables:

TocOpen: true

BreadCrumb Navigation

Adds BreadCrumb Navigation above Post's Title to show subsections and Navigation to Home

    ShowBreadCrumbs: true

Can be diabled for particular page's front-matter

ShowBreadCrumbs: false

Edit Link for Posts

Add a button to suggest changes by using the file path of the post to link to a edit destination.

For site config use:

        URL: "<gitlab user>/<repo name>/tree/<branch name>/<path to content>/"
        Text: "Suggest Changes" # edit text
        appendFilePath: true # to append file path to Edit link

Can be modified for individual pages

    URL: "<path_to_repo>/content"
    Text: "Suggest Changes" # edit text
    appendFilePath: true # to append file path to Edit link

The example above would yield the following link for the post file posts/<path_to_repo>/content/posts/

Parameter Required Default Value
editPost.URL true -
editPost.appendFilePath false false
editPost.Text false "Edit"

Since the link generated is a regular HTML anchor tag <a href=...>, you can also use other URL schemas like mailto://, e.g. URL: "mailto:// changes for "

Other Posts suggestion below a post

Adds a Previous / Next post suggestion under a single post

    ShowPostNavLinks: true

Code Copy Button

Adds a copy button in code block to copy the code it contains

    ShowCodeCopyButtons: true

Multiple Authors

To Use multiple authors for a post, in post-variables:

author: ["Me", "You"]

To use Multiple Authors Site-wide, in config.yml:

    author: ["Me", "You"]


to add comments, create a html file


and paste code provided by your comments provider

also in config add this

    comments: true

read more about this hugo-comments


c - ToC Open/Close
g - Go To Top
h - Home (according to current lang)
t - Theme toggle
/ - Jumps to search page if in menu

What's AccessKeys ?

Enhanced SEO

Enabled only when env: production

Multilingual Support


Scroll-Bar themed (by default)

Smooth Scroll between in-page links (by default)

Scroll-to-Top Button (by default)

Displays a Scroll-to-Top button in right-bottom corner

Google Analytics integration

Syntax highlighting

RSS feeds