diff options
| author | Nicholas Johnson <nick@nicksphere.ch> | 2022-10-23 00:00:00 +0000 |
|---|---|---|
| committer | Nicholas Johnson <nick@nicksphere.ch> | 2022-10-23 00:00:00 +0000 |
| commit | 518ec9aba88d5d6861ddbe57fa3b07f50c7cfe23e229215180288cf314a2ce2c (patch) | |
| tree | 497fe14302aefc110b5e848daad5992c2c08d539d7b4d515c5cc0d8adea4b967 | |
| parent | e007e7c412f793a95d0d029fe37aed1315d57bba49ee655a1ff43ab913105706 (diff) | |
Add a README
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e51c11f --- /dev/null +++ b/README.md @@ -0,0 +1,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 |