aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9e71417272c040e6c6786be764ee516b20cb27603b3fa3253651de5e0d4688b8 (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
# Journal Theme For Hugo

Hugo Journal Theme is an accessible, no-JS, minimalist, high-contrast Hugo theme that outputs Gemtext and HTML. It's suitable for blogs.

## Demo

A live demo of the theme can be found at the following domain: [https://nicholasjohnson.ch](https://nicholasjohnson.ch)

## Features

* Outputs Gemtext for the [Gemini protocol](https://gemini.circumlunar.space/docs/specification.gmi)
* 100⁄100 Google Lighthouse score
* Works well on all screen sizes
* No bloated Javascript
* Absolutely no analytics

## Get The Theme

Run from the root of your Hugo site:

```sh
$ git clone https://git.nicholasjohnson.ch/hugo-theme-journal themes/journal
```

Alternatively, if your Hugo site is version controlled, clone this theme as a git submodule:

```sh
$ git submodule add https://git.nicholasjohnson.ch/hugo-theme-journal themes/journal
```

## Generate The Site

To render the blog for Gemini and the Web, use separate configuration files. For guidance, look at [my journal repo](https://git.nicholasjohnson.ch/journal).

The [Gemtext compatibility document](GEMTEXT-COMPATIBILITY.md) explains which Markdown can be safely converted to Gemini.

## Versioning

This Hugo theme uses [Semantic Versioning 2.0.0](https://semver.org/).

## License

Hugo Journal Theme is licensed under [GPLv3 or later](LICENSE).