From 9e1ef48fc0d26fc5141bb53ef17793088dc262f3 Mon Sep 17 00:00:00 2001 From: earnest ma Date: Sat, 6 Feb 2021 12:55:46 -0500 Subject: [PATCH] chore: Update readme.md --- readme.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/readme.md b/readme.md index 61826e5..40c10be 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,15 @@ A simple, fully-featured Hugo blogging theme with Dracula colors. +Features: + +- Basic support for [Gemini output](https://gemini.circumlunar.space/) +- Full content RSS feed by default +- Support for author/ multi-author posts +- Support for "comments" through Mastodon's API (toot) +- Optional openring styling (generates a list of recent posts from blogs you follow) +- `noindex` param to prevent certain pages from being indexed + **Demo**: - [My personal site](https://www.earnestma.xyz) uses this theme. @@ -23,6 +32,52 @@ Regular and minified release tarbells are available: **[here](https://git.earne. ## Configuration +## Gemini Output + +Improvements welcome. + +`config.toml`: + +```toml +[mediaTypes] +[mediaTypes."text/gemini"] +suffixes = ["gmi"] + +[outputFormats] +[outputFormats.Gemini] +name = "GEMTEXT" +isPlainText = true +isHTML = false +mediaType = "text/gemini" +protocol = "gemini://" +permalinkable = true +path = "gemini/" + +[outputs] +section = ["HTML", "RSS"] +``` + +Blog posts (`post-filename.md`): + +A post that has both html and gemini output: +``` +title: "Example" +date: 2020-01-01 13:23:00 -0500 +draft: false +outputs: + - html + - gemtext +``` + +Just gemini: + +``` +outputs: + - gemtext +``` + +Gemini content will go in the same `post-filename.gmi`. A Makefile or automated CI can be used to transfer output and exclude certain files/ directories to the correct directories. + ## Contributing Please see [contributing.md](contributing.md). This project is licensed under the [MIT License](license.md).