1
0
Fork 0
hugo-paper/README.md
2021-08-20 19:39:36 +08:00

67 lines
1.4 KiB
Markdown
Executable file

<div align="center">
<h1>Paper <sup><sup><sub>5.0</sub></sup></sup></h1>
Demo → [nanxiaobei.github.io/hugo-paper](https://nanxiaobei.github.io/hugo-paper)
<hr />
A simple, clean, flexible Hugo theme.
⚡️ Fast | 🦋 Fluent | 🪀 Smooth
</div>
---
## Overview
<p>
<kbd>
<img src="https://raw.githubusercontent.com/nanxiaobei/hugo-paper/master/images/screenshot.png" alt="Paper">
</kbd>
</p>
<p>
<kbd>
<img src="https://raw.githubusercontent.com/nanxiaobei/hugo-paper/master/images/screenshot_dark.png" alt="Paper Dark Mode">
</kbd>
</p>
## Install
Inside the folder of your Hugo site, run:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
Then change in `config.toml`:
```toml
theme = "paper"
```
For more information read the official [guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
Check on Hugo themes: https://themes.gohugo.io/hugo-paper/
## Config
Available configurations to `config.toml`:
```toml
disqusShortname = 'YOUR_DISQUES_SHORTNAME'
[params]
disableHLJS = true # don't load highlight.js
twitter = 'YOUR_TWITTER_ID'
github = 'YOUR_GITHUB_ID'
instagram = 'YOUR_INSTAGRAM_ID'
```
## Pitiless Ads
If you use WeChat, please try "**FUTAKE**". It's a WeChat mini app for your inspiration moments. 🌈
![FUTAKE](https://s3.jpg.cm/2021/04/22/TDQuS.png)