diff options
| author | Nicholas Johnson <> | 2026-09-18 00:00:00 +0000 |
|---|---|---|
| committer | Nicholas Johnson <> | 2026-09-19 20:39:04 -0400 |
| commit | b171d00ceba32cd9372f2c748884474584e21f456445d12363c184deed81ded1 (patch) | |
| tree | fc9a12d15337d4e55005d7758d30bb6b9eef7930e322c617331df509ebe58e3a /exampleSite/hugo.gemini.toml | |
| parent | 0703a10e2c97bdce5fe8c2d83ce977b015bc68b2368eb43c3b3bdbc21d588155 (diff) | |
| download | hugo-theme-journal-b171d00ceba32cd9372f2c748884474584e21f456445d12363c184deed81ded1.tar.gz hugo-theme-journal-b171d00ceba32cd9372f2c748884474584e21f456445d12363c184deed81ded1.zip | |
Add an example site
The theme shipped no runnable site and documented no configuration, so
every setting it reads had to be discovered by reading the templates,
and there was nothing to build against when changing them. The build
failure that unset RSS limits caused would have been caught immediately
by an example site.
The two configuration files are the separate website and capsule
configurations the readme asks for, annotated with what each setting
does and which are optional. The content demonstrates entries, tags,
references, a standalone page and the front matter keys that control
them.
Also ignore build output, which no rule previously covered.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'exampleSite/hugo.gemini.toml')
| -rw-r--r-- | exampleSite/hugo.gemini.toml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/exampleSite/hugo.gemini.toml b/exampleSite/hugo.gemini.toml new file mode 100644 index 0000000..64d3956 --- /dev/null +++ b/exampleSite/hugo.gemini.toml @@ -0,0 +1,58 @@ +# Configuration for the capsule. The website is built from +# hugo.toml; see the readme for why the two are separate. + +baseURL = "gemini://example.com/" +languageCode = "en-us" +title = "A Journal" +# The directory name the theme is installed under in themes/. +theme = "journal" + +# "{currentYear}" is replaced with the year the site is built. +copyright = "Copyright (C) 2026 Example Author. Some rights reserved." + +# Lets entries use emoji shortcodes such as :smile: in their Markdown. +enableEmoji = true + +# A capsule has no use for either, and rendering the 404 page would pull +# the website's stylesheet into the capsule along with it. +disableKinds = ["404", "sitemap"] + +[params] + # Heading and opening paragraph of the homepage. + indexTitle = "A Journal" + indexIntro = "An example of the journal theme, an accessible, no-JS, minimalist, high-contrast theme that outputs both gemtext and HTML." + + # Atom feeds require at least the author name. + author = { name = "Example Author", email = "author@example.com" } + + # Used for the description meta element and as the feed subtitle. + description = "An example journal built with the journal theme." + + # Optional. Used for the keywords meta element. + keywords = "journal, example, gemini" + + # Optional. Any layout that time.Format accepts, or one of Hugo's + # named layouts. Defaults to ":date_long". + dateFormat = ":date_long" + +[taxonomies] + tag = "tags" + +# Each kind must list the formats it is rendered in. Leaving a kind out +# falls back to Hugo's defaults, which would render the kind as HTML +# into the capsule. +[outputs] + home = ["Gemini", "Gemini_Atom"] + section = ["Gemini"] + taxonomy = ["Gemini", "Gemini_Atom"] + term = ["Gemini", "Gemini_Atom"] + page = ["Gemini"] + +# Optional. Caps the number of entries in a feed; unlimited by default. +# [services.rss] +# limit = 20 + +[[menu.main]] + name = "About" + url = "/about/" + weight = 1 |
