From 2ca3afba36b42b661fe5413d0afa4069a12883bf Mon Sep 17 00:00:00 2001 From: Niklas Buschmann Date: Fri, 18 Dec 2020 18:19:51 +0100 Subject: [PATCH] add example config --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fc30614..b9379a1 100644 --- a/README.md +++ b/README.md @@ -7,18 +7,36 @@ To install Contrast as your default theme, first install this repository in the $ cd themes/ $ git clone https://github.com/niklasbuschmann/contrast-hugo.git -Second, specify `contrast-hugo` as your default theme in the `config.yaml` file. Just add the line +Second, specify `contrast-hugo` as your default theme in the `config.toml` file. Just add the line - theme: "contrast-hugo" + theme = "contrast-hugo" at the top of the file. +### Example config + +``` +title = "Davids Blog" +author = "David Wallace" +theme = "contrast-hugo" + +[params] + minimal = false + description = "my blog" + +[menu] + [[menu.main]] + identifier = "about" + name = "About" + url = "/about/" + weight = 10 +``` + ## Based on - [Hyde](https://github.com/poole/hyde) - [Minima](https://github.com/jekyll/minima) - [KaTeX](https://katex.org/) -- [Font-Awesome](https://fontawesome.com/) ## License