update docs
This commit is contained in:
parent
f1387bfc37
commit
01742beef1
1 changed files with 23 additions and 8 deletions
31
README.md
31
README.md
|
@ -1,15 +1,20 @@
|
|||
# Paper <sup><sup><sub>v4.9 (Dark Mode)</sub></sup></sup>
|
||||
<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
|
||||
⚡️ Fast | 🦋 Fluent | 🪀 Smooth
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Demo: https://nanxiaobei.github.io/hugo-paper/
|
||||
|
||||
<p>
|
||||
<kbd>
|
||||
<img src="https://raw.githubusercontent.com/nanxiaobei/hugo-paper/master/images/screenshot.png" alt="Paper">
|
||||
|
@ -22,8 +27,6 @@ Demo: https://nanxiaobei.github.io/hugo-paper/
|
|||
</kbd>
|
||||
</p>
|
||||
|
||||
Hugo themes: https://themes.gohugo.io/hugo-paper/
|
||||
|
||||
## Install
|
||||
|
||||
Inside the folder of your Hugo site, run:
|
||||
|
@ -40,9 +43,21 @@ theme = "paper"
|
|||
|
||||
For more information read the official [guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
|
||||
|
||||
## Dark Mode
|
||||
Check on Hugo themes: https://themes.gohugo.io/hugo-paper/
|
||||
|
||||
It's automatic, according to your system settings, or the natural time of day and night.
|
||||
## 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
|
||||
|
||||
|
|
Loading…
Reference in a new issue