Hugo Themes

Prev/Next: All Themes

Paper

A simple, clean, flexible Hugo theme

Author: nanxiaobei
GitHub Stars: 2109
Updated: 2024-09-11
License: MIT
Tags: Blog Light Responsive

Download

Link in bio to widgets, your online home screen. ➫ kee.so

Paper ^{^_6.27}

Demo → hugo-paper.vercel.app

A simple, clean, customizable Hugo theme.

⚡️ Fast | 👒 Customizable | 🫙 Smooth

Links

Product Hunt: producthunt.com/posts/hugo-paper-6

Hugo themes: themes.gohugo.io/hugo-paper

Overview

Options

Available options to config.toml or hugo.toml:

[services]
  [services.disqus]
    shortname = 'YOUR_DISQUS_SHORTNAME'     # use disqus comments

[params]
  # color style
  color = 'linen'                           # linen, wheat, gray, light

  # header social icons
  twitter = 'YOUR_TWITTER_ID'               # twitter.com/YOUR_TWITTER_ID
  github = 'YOUR_GITHUB_ID'                 # github.com/YOUR_GITHUB_ID
  instagram = 'YOUR_INSTAGRAM_ID'           # instagram.com/YOUR_INSTAGRAM_ID
  linkedin = 'YOUR_LINKEDIN_ID'             # linkedin.com/in/YOUR_LINKEDIN_ID
  mastodon = 'YOUR_MASTODON_LINK'           # e.g. 'https://mastodon.instance/@xxx'
  threads = '@YOUR_THREADS_ID'              # threads.net/@YOUR_THREADS_ID
  rss = true                                # show rss icon

  # home page profile
  avatar = 'GRAVATAR_EMAIL'                 # gravatar email or image url
  name = 'YOUR_NAME'
  bio = 'YOUR_BIO'


  # misc
  disableHLJS = true                        # disable highlight.js
  disablePostNavigation = true              # disable post navigation
  monoDarkIcon = true                       # show monochrome dark mode icon
  gravatarCdn = 'GRAVATAR_CDN_LINK'         # e.g. 'https://cdn.v2ex.com/gravatar/'
  math = true                               # enable KaTeX math typesetting globally
  localKatex = false                        # use local KaTeX js/css instead of CDN
  graphCommentId = "YOUR_GRAPH_COMMENT_ID"  # use graph comment (disqus alternative)
  favicon = "favicon.ico"                   # customize the default favicon
  appleTouchIcon = "apple-touch-icon.png"   # customize the default Apple touch icon

  # RTL supprot
  direction = "rtl"                         # RTL support for Right-to-left languages

  # giscus
[params.giscus]
  repo = 'YOUR_GISCUS_REPO'                 # see https://giscus.app for more details
  repoId = 'YOUR_GISCUS_REPO_ID'
  category = 'YOUR__GISCUS_CATEGORY'
  categoryId = 'YOUR_GISCUS_CATEGORY_ID'
  mapping = 'pathname'
  theme = 'light'
  lang = 'zh-CN'

Available options to front matter:

comments = false                            # disable comments for a specific page
math = true                                 # enable KaTeX math typesetting for a specific page

Install

As git submodule

Inside the folder of your Hugo project, run:

git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper

Open config.toml(or hugo.toml), change theme to "paper":

theme = "paper"

For more information, please read the official guide of Hugo.

As hugo module

Add paper theme ad dependency of your site:

hugo mod init github.com/<your_user>/<your_project>

Open config.toml(or hugo.toml), remove the theme line (if present), add module section to the bottom of the file:

[module]
  [[module.imports]]
    path = "github.com/nanxiaobei/hugo-paper"