Skip to content

nanxiaobei/hugo-paper

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
November 7, 2023 17:34
November 7, 2023 17:34
September 17, 2023 11:32
February 26, 2023 00:19
October 20, 2023 16:41
June 7, 2023 02:23
August 24, 2021 07:59
July 18, 2022 23:36
August 15, 2023 04:41
July 18, 2022 23:36
August 16, 2022 00:51
January 12, 2023 15:17
November 6, 2023 20:31
August 14, 2023 22:11
November 6, 2023 20:31
November 7, 2023 17:35
July 18, 2022 23:36
February 24, 2023 13:02

kee.so

Create now kee.so


Paper 6.24

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

  # 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 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