Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nanxiaobei/hugo-paper.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornanxiaobei <nanxiaobei@gmail.com>2021-08-20 19:51:03 +0300
committernanxiaobei <nanxiaobei@gmail.com>2021-08-20 19:51:03 +0300
commit088631159bc6d8ef85608535b26b589921bb7688 (patch)
tree08ce93cbdfff58951813bc3c743db220879eb36e /README.md
parent8c001f75609b2fd64d9555e42015dd89cefcff8a (diff)
update docs
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index d127863..da057c4 100755
--- a/README.md
+++ b/README.md
@@ -22,29 +22,29 @@ Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
## Install
-Inside the folder of your Hugo site, run:
+Inside the folder of your Hugo project, run:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
-Then change in `config.toml`:
+Open `config.toml`, change `theme` to `"paper"`:
```toml
theme = "paper"
```
-For more information read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
+For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo.
-## Config
+## Options
-Available configurations to `config.toml`:
+Available options to `config.toml`:
```toml
disqusShortname = 'YOUR_DISQUES_SHORTNAME'
[params]
- disableHLJS = true # don't load highlight.js
+ disableHLJS = true # don't use highlight.js
twitter = 'YOUR_TWITTER_ID'
github = 'YOUR_GITHUB_ID'
instagram = 'YOUR_INSTAGRAM_ID'