malte70
/
hugo-paper
1
0
Fork 0
Code

update docs

This commit is contained in:
nanxiaobei 2023-07-07 16:45:40 +08:00
parent 9c48a92ace
commit b2c5307a43
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -5,9 +5,9 @@ Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)
<hr />
A simple, clean, flexible Hugo theme.
A simple, clean, customizable Hugo theme.
⚡️ Fast | 📸 Fluent | 🫙 Smooth
⚡️ Fast | 👒 Customizable (`linen` ░ `wheat` ░ `gray` ░ `light`) | 🫙 Smooth
</div>
@ -26,22 +26,6 @@ Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/)
![](./images/screenshot_mobile.png)
![](./images/pagespeed.png)
## Install
Inside the folder of your Hugo project, run:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
Open `config.toml` or `hugo.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` or `hugo.toml`:
@ -82,6 +66,22 @@ comments = false # disable comments for a specific pa
math = true # enable KaTex math typesetting for a specific page
```
## Install
Inside the folder of your Hugo project, run:
```bash
git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper
```
Open `config.toml` or `hugo.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.
## License
[MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)