contrast-hugo/README.md

35 lines
815 B
Markdown
Raw Normal View History

2019-07-18 15:32:22 -04:00
Adaption of the Jekyll version of [contrast](https://github.com/niklasbuschmann/contrast).
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
Second, specify `contrast-hugo` as your default theme in the `config.toml` file. Just add the line
theme = "contrast-hugo"
at the top of the file.
2019-07-19 12:54:30 -04:00
## Options
To use the bright header, you can set `brightheader = true` in the `params` section of your config.
2019-07-18 15:32:22 -04:00
## Features
- supports dark mode on macOS Mojave
- MathJax support
2019-07-18 15:49:34 -04:00
- no external resources
2019-07-18 15:32:22 -04:00
- responsive
## Based on
- [Minima](https://github.com/jekyll/minima)
- [KaTeX](https://katex.org/)
## License
[public domain](http://unlicense.org/)