README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Black & Light

A High contrast, text oriented, performant and Javascript-free theme for Hugo.

## Features
* Loads in a single request (with web-fonts disabled).
* 100 / 100 on Google Page Speed test (100 / 100 on mobile with web-fonts disabled).
* Scriptless (unless you configure Google Analytics).
* Styles inlined in head.
* High Contrast.
* Supports dark color scheme via [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme).
* High Resolution Favicons.

![Screenshot](https://github.com/davidhampgonsalves/hugo-black-and-light-theme/blob/master/images/screenshot.png)

## Installation
Inside the folder of your Hugo site run:
```
  git submodule add https://github.com/davidhampgonsalves/hugo-black-and-light-theme.git themes/black-and-light
```
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.

## The config file
Copy the [`config.toml`](//github.com/davidhampgonsalves/hugo-black-and-light-theme/blob/master/exampleSite/config.toml) from this themes exampleSite to your Hugo site or use it as a reference.

## License
This theme is released under the GPL 3.0 license. For more information read the [license](https://raw.githubusercontent.com/davidhampgonsalves/hugo-black-and-light-theme/master/LICENSE).