Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanxiaobei/hugo-paper
🪺 A simple, clean, customizable Hugo theme
https://github.com/nanxiaobei/hugo-paper
blog clean dark dark-mode design flex flexible hugo hugo-theme paper simple theme white
Last synced: 24 days ago
JSON representation
🪺 A simple, clean, customizable Hugo theme
- Host: GitHub
- URL: https://github.com/nanxiaobei/hugo-paper
- Owner: nanxiaobei
- License: mit
- Created: 2018-01-08T16:26:30.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:21:18.000Z (about 2 months ago)
- Last Synced: 2024-09-29T05:23:39.008Z (about 1 month ago)
- Topics: blog, clean, dark, dark-mode, design, flex, flexible, hugo, hugo-theme, paper, simple, theme, white
- Language: CSS
- Homepage: https://hugo-paper.vercel.app
- Size: 7.48 MB
- Stars: 2,102
- Watchers: 8
- Forks: 486
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - nanxiaobei/hugo-paper - 🪺 A simple, clean, customizable Hugo theme (CSS)
- awesome - nanxiaobei/hugo-paper - 🪺 A simple, clean, customizable Hugo theme (CSS)
README
Link in bio to **widgets**,
your online **home screen**. ➫ [kee.so](https://kee.so/)
---
Paper 6.27
Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)
A simple, clean, customizable Hugo theme.
⚡️ Fast | 👒 Customizable | 🫙 Smooth
## Links
Product Hunt: [producthunt.com/posts/hugo-paper-6](https://www.producthunt.com/posts/hugo-paper-6)
Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
## Overview
## Options
Available options to `config.toml` or `hugo.toml`:
```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:
```toml
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:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
Open `config.toml`(or `hugo.toml`), change `theme` to `"paper"`:
```toml
theme = "paper"
```
For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#configure-the-site) of Hugo.
### As hugo module
Add paper theme ad dependency of your site:
```bash
hugo mod init github.com//
```
Open `config.toml`(or `hugo.toml`), remove the `theme` line (if present), add `module` section to the bottom of the file:
```toml
[module]
[[module.imports]]
path = "github.com/nanxiaobei/hugo-paper"
```
For more information, please read the [official guide](https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme) of Hugo.
## License
[MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)