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

README.md - github.com/bake/solar-theme-hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 6535b21c15fb9b6df46f643ef92aff09d2d64144 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Solar Theme for Hugo

A minimalistic theme for [Hugo](https://gohugo.io/) blogs, fork of
[Solar Theme for Ghost](https://github.com/mattvh/solar-theme-ghost). There is a
demo available on
[Hugos theme list](https://themes.gohugo.io/theme/solar-theme-hugo/). See the
[example config.toml](exampleSite/config.toml) for a starting point.

## Color schemes

Solar offers three color schemes: (Solarized) `light`, (Solarized) `dark`
(default) and `gray`. Additionally there is a `preference` setting which
switches between `light` and `dark` according to the users preference.

## Screenshot

![Screenshot](/images/tn.png)

## Additional HTML

Custom HTML can be injected just before `</head>` and `</body>` by creating a
`head.html` or `foot.html` inside the sites `layouts/partials/` folder. The
default (empty) logo can be overwritten by creating a `logo.svg` in
`static/img/`.

## Syntax Highlighting

This theme does not bring a syntax highlighter. If you want to use
[Hugos built in one](https://gohugo.io/content-management/syntax-highlighting/),
remember to update the color scheme by
[setting pygmentsStyle](/exampleSite/config.toml#L4). The pygments style
`solarized-dark`, for example, matches the themes `dark` color scheme, while
`solarized-light` matches `light` and `solarized-dark256` works well with
`gray`.

Otherwise, if you want to use a JavaScript highlighter like
[highlight.js](https://highlightjs.org/), the necessary JavaScript can be placed
inside `static/` and get included by providing a `footer.html` as described
above.

## Installation

Same as with any other theme:

```bash
$ git clone https://github.com/bake/solar-theme-hugo.git themes/solar-theme-hugo
$ hugo server --theme solar-theme-hugo
...
```

## License

GPLv2 or higher