Meine modifikationen des Paper-Themes für Hugo

Find a file

wwwatson b78b9ce8d4 docs: update README		2023-09-13 20:25:45 +08:00
assets	fix pre inside blockquote	2023-08-19 01:04:57 +08:00
exampleSite	refine code	2023-08-19 01:05:01 +08:00
i18n	Create sw.yaml	2023-08-22 23:34:57 +03:00
images	update pagespeed image	2023-02-26 00:19:46 +08:00
layouts	feat: add giscus comment	2023-09-13 20:15:14 +08:00
static	add linkedin	2023-06-07 02:23:33 +08:00
.gitignore	update .gitignore	2021-08-24 07:59:26 +08:00
.prettierignore	update configs	2022-07-18 23:36:23 +08:00
.prettierrc.js	upgrade deps	2023-08-15 04:41:40 +08:00
.stylelintignore	update configs	2022-07-18 23:36:23 +08:00
.stylelintrc.js	upgrade deps	2022-08-16 00:51:52 +08:00
go.mod	Offer theme as hugo module	2023-08-14 22:11:17 +02:00
LICENSE	update license	2023-01-12 15:17:50 +08:00
package.json	6.21.0	2023-08-19 01:06:07 +08:00
pnpm-lock.yaml	upgrade deps	2023-08-19 01:05:36 +08:00
README.md	docs: update README	2023-09-13 20:25:45 +08:00
tailwind.config.js	update configs	2022-07-18 23:36:23 +08:00
theme.toml	Add link to demo site	2023-02-24 13:02:42 +11:00

README.md

Create now ➫ 🔗 kee.so

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

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