1
0
Fork 0
hugo-paper/README.md
Richard Yhip d70450ef0f
Update README.md
minor fix for disqus placeholder text
2021-09-11 22:59:01 -04:00

58 lines
1.5 KiB
Markdown
Executable file

<div align="center">
<h1>Paper <sup><sup><sub>5.1</sub></sup></sup></h1>
Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)
<hr />
A simple, clean, flexible Hugo theme.
⚡️ Fast | 🦋 Fluent | 🪀 Smooth
</div>
---
## Overview
![Desktop](https://raw.githubusercontent.com/nanxiaobei/hugo-paper/master/images/screenshot.png)
![Mobile](https://raw.githubusercontent.com/nanxiaobei/hugo-paper/master/images/screenshot_mobile.png)
Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
## Install
Inside the folder of your Hugo project, run:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
Open `config.toml`, change `theme` to `"paper"`:
```toml
theme = "paper"
```
For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
## Options
Available options to `config.toml`:
```toml
disqusShortname = 'YOUR_DISQUS_SHORTNAME' # add disqus comments
[params]
disableHLJS = true # don't use highlight.js
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
```
## 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)