summaryrefslogtreecommitdiff
path: root/exampleSite/content/entry
diff options
context:
space:
mode:
authorNicholas Johnson <>2026-09-18 00:00:00 +0000
committerNicholas Johnson <>2026-09-19 20:39:04 -0400
commitb171d00ceba32cd9372f2c748884474584e21f456445d12363c184deed81ded1 (patch)
treefc9a12d15337d4e55005d7758d30bb6b9eef7930e322c617331df509ebe58e3a /exampleSite/content/entry
parent0703a10e2c97bdce5fe8c2d83ce977b015bc68b2368eb43c3b3bdbc21d588155 (diff)
downloadhugo-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/content/entry')
-rw-r--r--exampleSite/content/entry/tagging.md20
-rw-r--r--exampleSite/content/entry/welcome.md26
-rw-r--r--exampleSite/content/entry/writing-entries.md36
3 files changed, 82 insertions, 0 deletions
diff --git a/exampleSite/content/entry/tagging.md b/exampleSite/content/entry/tagging.md
new file mode 100644
index 0000000..caef813
--- /dev/null
+++ b/exampleSite/content/entry/tagging.md
@@ -0,0 +1,20 @@
+---
+title: "Tagging"
+date: 2026-03-08T11:00:00+0000
+draft: false
+tags: ["journal", "gemini"]
+makerefs: false
+---
+
+Tags are listed alongside the date and reading time of an entry, and
+each one gets a page and a feed of its own.
+
+This entry sets "makerefs" to false, so its links are rendered where
+they appear rather than being collected at the foot of the page. In
+gemtext a link must occupy a whole line, so only links written on their
+own line become link lines:
+
+[The tag list for this site](/tags/)
+
+Set "showlinkemoji" to false in the front matter to drop the link emoji
+from those lines.
diff --git a/exampleSite/content/entry/welcome.md b/exampleSite/content/entry/welcome.md
new file mode 100644
index 0000000..614a490
--- /dev/null
+++ b/exampleSite/content/entry/welcome.md
@@ -0,0 +1,26 @@
+---
+title: "Welcome To The Journal Theme"
+date: 2026-01-15T09:00:00+0000
+draft: false
+tags: ["journal", "hugo"]
+---
+
+This entry is written once and published twice: as HTML for the web and
+as gemtext for the [Gemini protocol](https://geminiprotocol.net/).
+
+By default, links are collected into a reference section at the foot of
+the gemtext version, because gemtext has no inline links. The same entry
+keeps its inline links in the HTML version. Set "makerefs" to false in
+an entry's front matter to render links in place on both instead.
+
+## What The Theme Gives You
+
+* An entry list on the homepage, and one per tag
+* Atom feeds for the homepage, each tag and the tag list
+* Publication date and reading time on every entry
+* Optional audio versions of entries
+* No JavaScript and no analytics
+
+Which Markdown features survive the trip to gemtext, and which are
+flattened or dropped, is documented in full in the
+[gemtext compatibility reference guide](https://git.nicholasjohnson.ch/hugo-theme-journal/tree/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md).
diff --git a/exampleSite/content/entry/writing-entries.md b/exampleSite/content/entry/writing-entries.md
new file mode 100644
index 0000000..8184c32
--- /dev/null
+++ b/exampleSite/content/entry/writing-entries.md
@@ -0,0 +1,36 @@
+---
+title: "Writing Entries"
+date: 2026-02-20T14:30:00+0000
+draft: false
+tags: ["journal"]
+---
+
+Create an entry with the "entry" archetype:
+
+```sh
+hugo new --kind entry entry/my-first-entry.md
+```
+
+Entries are Markdown. Headings, lists, blockquotes and preformatted
+blocks all survive into gemtext:
+
+> Gemtext has no nesting and no inline emphasis, so the theme flattens
+> what it can and drops the rest.
+
+Emphasis is a good example. *Italics* and **bold** are rendered on the
+web, and their asterisks are removed from the gemtext, so write in a way
+that still reads without them.
+
+## Adding An Audio Version
+
+Make the entry a page bundle and put the audio file beside it:
+
+```plaintext
+content/entry/my-first-entry/
+├── index.md
+└── my-first-entry.opus
+```
+
+The website gets an audio player and the capsule gets a download link.
+Include more than one encoding and browsers pick the format they
+support, while the capsule only links the most preferred one.