summaryrefslogtreecommitdiff
path: root/README.md
blob: e51c11fc3c02ff551b0b212230af31ea225297787e5b15a1bfc8cd09e5beec72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# hugo-theme-nicksphere
An accessible, no-JS, minimalist, high-contrast Hugo theme that outputs Gemtext and HTML. Suitable for blogs.

## Clone to Your Theme Directory
```bash
$ git clone https://git.nicksphere.ch/hugo-theme-nicksphere themes/hugo-theme-nicksphere
```

## Generate The Blog
Since Hugo can't separate the Gemtext and HTML output by itself, this theme uses two scripts to handle the output:

* `python3 themes/hugo-theme-nicksphere/scripts/generate.py` outputs the site and the capsule
* `python3 themes/hugo-theme-nicksphere/scripts/clean.py` removes previously generated output

If the correct media types, output formats, markup settings, and outputs are not specified in config.toml, the above scripts may fail or the blog may render correctly. Have a look at the [nicksphere repository](https://git.nicksphere.ch/nicksphere/tree/config.toml) for ideas on how to set up your config.toml.

## License
GPLv3 or later