malte70/hugo-paper
1
0
Fork 0
Code Activity

update docs

Browse source
This commit is contained in:
nanxiaobei 2021-08-21 00:51:03 +08:00
parent 8c001f7560
commit 088631159b
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -22,29 +22,29 @@ Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
## Install ## Install
Inside the folder of your Hugo site, run: Inside the folder of your Hugo project, run:
```bash ```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
``` ```
Then change in `config.toml`: Open `config.toml`, change `theme` to `"paper"`:
```toml ```toml
theme = "paper" 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 ```toml
disqusShortname = 'YOUR_DISQUES_SHORTNAME' disqusShortname = 'YOUR_DISQUES_SHORTNAME'
[params] [params]
disableHLJS = true # don't load highlight.js disableHLJS = true # don't use highlight.js
twitter = 'YOUR_TWITTER_ID' twitter = 'YOUR_TWITTER_ID'
github = 'YOUR_GITHUB_ID' github = 'YOUR_GITHUB_ID'
instagram = 'YOUR_INSTAGRAM_ID' instagram = 'YOUR_INSTAGRAM_ID'