Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/niklasbuschmann/contrast-hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiklas Buschmann <niklasbuschmann@posteo.org>2020-12-18 20:19:51 +0300
committerNiklas Buschmann <niklasbuschmann@posteo.org>2020-12-18 20:19:51 +0300
commit2ca3afba36b42b661fe5413d0afa4069a12883bf (patch)
treec8ff41e4ccfe9d8c44f46242836dc3c1212696b5
parentc4e97028fbee087ec1675e6d88c7282c1e38bd3a (diff)
add example config
-rw-r--r--README.md24
1 files 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