kaholaz/hello-friend-ng
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Start to document the config settings

Browse source
This commit is contained in:
Djordje Atlialp 2020-05-15 09:52:56 +02:00
parent 886be61c75
commit 90ee9fd9d5
No known key found for this signature in database
GPG key ID: 50C5BBECF350BB74
2 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -54,6 +54,7 @@ $ git submodule add https://github.com/rhazdon/hugo-theme-hello-friend-ng.git th
## How to configure ## How to configure
The theme doesn't require any advanced configuration. Just copy the following config file. The theme doesn't require any advanced configuration. Just copy the following config file.
To see all possible configurations, [check the docs](docs/config.md).
Note: There are more options to configure. Take a look into the `config.toml` in `exampleSite`. Note: There are more options to configure. Take a look into the `config.toml` in `exampleSite`.
``` toml ``` toml

15
docs/config.md Normal file
View file

@ -0,0 +1,15 @@
# Configuration
There are some settings you can set in your `config.toml`.
## Default area
The settings in the default area are usually provided by Hugo itself. Check [Configure Hugo](https://gohugo.io/getting-started/configuration/#all-configuration-settings) for more information. But I want to list some important things here which are relevant to this theme.
### paginate
```
paginate = 10
```
This setting will paginate your list views. Set to `0` to disable it. For more information check (https://gohugo.io/templates/pagination/).