1
0
Fork 0
hugo-paper/README.md

81 lines
2.2 KiB
Markdown
Raw Normal View History

2021-08-20 13:39:36 +02:00
<div align="center">
2022-12-24 21:15:46 +01:00
<h1>Paper <sup><sup><sub>6.5</sub></sup></sup></h1>
2021-08-20 13:39:36 +02:00
2021-08-24 02:15:41 +02:00
Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)
2021-08-20 13:39:36 +02:00
<hr />
2018-05-04 19:41:09 +02:00
2019-04-01 11:57:38 +02:00
A simple, clean, flexible Hugo theme.
2022-07-18 18:49:29 +02:00
⚡️ Fast | 📸 Fluent | 🫙 Smooth
2021-08-20 13:39:36 +02:00
</div>
2019-04-01 11:57:38 +02:00
2019-08-19 23:12:16 +02:00
---
2018-05-04 19:41:09 +02:00
2021-12-21 07:27:05 +01:00
## Links
2022-07-21 21:17:38 +02:00
Product Hunt: [producthunt.com/posts/hugo-paper-6](https://www.producthunt.com/posts/hugo-paper-6)
2021-12-21 07:27:05 +01:00
Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
2018-07-06 05:25:22 +02:00
## Overview
2018-05-04 19:41:09 +02:00
2022-07-18 18:29:32 +02:00
![](https://raw.githubusercontent.com/nanxiaobei/hugo-paper/main/images/screenshot.png)
![](https://raw.githubusercontent.com/nanxiaobei/hugo-paper/main/images/screenshot_dark.png)
![](https://raw.githubusercontent.com/nanxiaobei/hugo-paper/main/images/screenshot_mobile.png)
2021-08-20 17:27:34 +02:00
2019-04-01 11:57:38 +02:00
## Install
2018-01-08 17:28:39 +01:00
2021-08-20 18:51:03 +02:00
Inside the folder of your Hugo project, run:
2018-01-08 17:28:39 +01:00
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
2021-08-20 18:51:03 +02:00
Open `config.toml`, change `theme` to `"paper"`:
2019-08-19 23:12:16 +02:00
```toml
theme = "paper"
2018-01-08 17:28:39 +01:00
```
2021-08-20 18:51:03 +02:00
For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
2020-05-14 22:12:13 +02:00
2021-08-20 18:51:03 +02:00
## Options
2021-08-20 13:39:36 +02:00
2021-08-20 18:51:03 +02:00
Available options to `config.toml`:
2021-08-20 13:39:36 +02:00
```toml
disqusShortname = 'YOUR_DISQUS_SHORTNAME' # add disqus comments
2021-08-20 13:39:36 +02:00
[params]
2022-08-21 07:57:54 +02:00
# color style
color = 'linen' # linen, wheat, gray, light
2022-08-15 20:20:41 +02:00
# 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
2022-12-24 21:14:16 +01:00
mastodon = 'YOUR_MASTODON_LINK' # mastodon.instance/@xxx
2022-08-15 20:20:41 +02:00
rss = true # show rss icon with link
# home page profile
avatar = 'GRAVATAR_EMAIL' # Gravatar email or image url(e.g. "https://deno.land/logo.svg")
name = 'YOUR_NAME'
bio = 'YOUR_BIO'
# misc
disableHLJS = true # disable requesting highlight.js
monoDarkIcon = true # show monochrome dark mode icon
2021-08-20 13:39:36 +02:00
```
2021-04-18 18:44:12 +02:00
2021-09-22 08:43:02 +02:00
## License
2021-04-18 18:44:12 +02:00
2022-07-18 18:29:32 +02:00
[MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)
2021-04-18 18:44:12 +02:00
2021-09-22 08:43:02 +02:00
## FUTAKE
Try [**FUTAKE**](https://sotake.com/f) in WeChat. A mini app for your inspiration moments. 🌈
2022-07-20 18:28:26 +02:00
![](https://s3.bmp.ovh/imgs/2022/07/21/452dd47aeb790abd.png)