Paper ^{^_6.21}

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:

disqusShortname = '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'
  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/'
  graphCommentId = "YOUR_GRAPH_COMMENT_ID"  # use graph comment (disqus alternative)
  math = true                               # enable KaTeX math typesetting globally

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 hugo module

Inside the folder of your Hugo project, run:

hugo mod init github.com/<USERNAME>/<REPONAME>

Add paper theme ad dependency of your site:

hugo mod init github.com/<USERNAME>/<REPONAME>

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

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

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

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.

License

MIT License (c) nanxiaobei

3.3 KiB Raw Permalink Blame History Unescape Escape

Paper 6.21