diff options
| author | Nicholas Johnson <nick@nicholasjohnson.ch> | 2023-05-04 00:00:00 +0000 |
|---|---|---|
| committer | Nicholas Johnson <nick@nicholasjohnson.ch> | 2023-05-04 00:00:00 +0000 |
| commit | afe33bd1747f4327fd912dbc1a8fb4579bf5330f812dc28efa7a3f730fcc5bf9 (patch) | |
| tree | 17681c592929724f57a79619437e3cd7f1bb56a14b944bbc2303b8ef00f83e88 | |
| parent | e2a3544ef6679c7230ea982f533357574ee1675857fc3d0ecb04ed4d40a77f69 (diff) | |
| download | hugo-theme-journal-afe33bd1747f4327fd912dbc1a8fb4579bf5330f812dc28efa7a3f730fcc5bf9.tar.gz hugo-theme-journal-afe33bd1747f4327fd912dbc1a8fb4579bf5330f812dc28efa7a3f730fcc5bf9.zip | |
Improve README
| -rw-r--r-- | GEMTEXT-COMPATIBILITY.md | 0 | ||||
| -rw-r--r-- | README.md | 45 |
2 files changed, 36 insertions, 9 deletions
diff --git a/GEMTEXT-COMPATIBILITY.md b/GEMTEXT-COMPATIBILITY.md new file mode 100644 index 0000000..473a0f4 --- /dev/null +++ b/GEMTEXT-COMPATIBILITY.md @@ -1,16 +1,43 @@ -# hugo-theme-journal -An accessible, no-JS, minimalist, high-contrast Hugo theme that outputs Gemtext and HTML. Suitable for blogs. +# Journal Theme For Hugo -## Clone to Your Theme Directory -```bash +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 +* Looks good 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 ``` -## Generate The Blog -In order to render the blog in Gemini and Web format, it's best to render it with separate configuration files. Have a look at [my journal repo](https://git.nicholasjohnson.ch/journal) for an example. +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 -GPLv3 or later -## Version -This Hugo theme uses [semantic versioning](https://semver.org/) with Git tags. +Hugo Journal Theme is licensed under [GPLv3 or later](/LICENSE). |