blob: ab8bda28fbacc1851c63c2c65df31331053c48ba4dfb062827a4212046c83fd4 (
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
|
# 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)
* Multilingual support
* 100/100 Google Lighthouse score
* Works well on all screen sizes
* No bloated Javascript
* Absolutely no analytics
## Supported Languages
* English
* Spanish
## Documentation
The [gemtext compatibility reference guide](GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md) documents the compatibility of Markdown features with gemtext as an output format in of this Hugo theme. The [gemtext compatibility rationale document](GEMTEXT-COMPATIBILITY-RATIONALE.md) explains the rationale behind the design decisions for the gemtext output format.
## 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
**Notice:** Hugo versions above v0.113.0 produce errors with this theme due to [a recently introduced bug](https://github.com/gohugoio/hugo/issues/11131 "Unexpected results with append template function") in how Hugo handles slices.
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).
## Versioning
This Hugo theme uses [Semantic Versioning 2.0.0](https://semver.org/).
## License
Hugo Journal Theme is licensed under [GPLv3 or later](LICENSE).
|
