contrast-hugo/README.md

44 lines
888 B
Markdown
Raw Normal View History

2020-02-03 21:04:06 -05:00
Adaption of the of [contrast](https://github.com/niklasbuschmann/contrast) Jekyll theme.
2019-07-18 15:32:22 -04:00
2019-07-18 15:49:34 -04:00
## Installation
2019-07-19 06:42:58 -04:00
To install Contrast as your default theme, first install this repository in the `themes/` directory:
2019-07-18 15:49:34 -04:00
$ cd themes/
$ git clone https://github.com/niklasbuschmann/contrast-hugo.git
2020-12-18 12:19:51 -05:00
Second, specify `contrast-hugo` as your default theme in the `config.toml` file. Just add the line
2019-07-18 15:49:34 -04:00
2020-12-18 12:19:51 -05:00
theme = "contrast-hugo"
2019-07-18 15:49:34 -04:00
at the top of the file.
2020-12-18 12:19:51 -05:00
### 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
```
2019-07-18 15:32:22 -04:00
## Based on
2020-02-03 21:04:06 -05:00
- [Hyde](https://github.com/poole/hyde)
2019-07-18 15:32:22 -04:00
- [Minima](https://github.com/jekyll/minima)
- [KaTeX](https://katex.org/)
## License
[public domain](http://unlicense.org/)