add example config

This commit is contained in:
Niklas Buschmann 2020-12-18 18:19:51 +01:00
parent c4e97028fb
commit 2ca3afba36
1 changed files with 21 additions and 3 deletions

View File

@ -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