From 90ee9fd9d59c01a6194467a3f9507f77dc4a106e Mon Sep 17 00:00:00 2001 From: Djordje Atlialp Date: Fri, 15 May 2020 09:52:56 +0200 Subject: [PATCH] Start to document the config settings --- README.md | 1 + docs/config.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 docs/config.md diff --git a/README.md b/README.md index 99586b1..6acb58d 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ $ git submodule add https://github.com/rhazdon/hugo-theme-hello-friend-ng.git th ## How to configure 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`. ``` toml diff --git a/docs/config.md b/docs/config.md new file mode 100644 index 0000000..b632286 --- /dev/null +++ b/docs/config.md @@ -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/).