summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-05-29 17:02:21 +0300
committerPaul Buetow <paul@buetow.org>2026-05-29 17:02:21 +0300
commita956a672859e92190149506197ad0fa682e964e2 (patch)
treea5f168aef3302ad9d633f1bca56f16b320fe3e19 /README.md
parent649a41dc0f0cbfa697408db2f006d106ba655933 (diff)
feat(showcase): uq move cgit host and output dir into config
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 851cda9..7fb166e 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,8 @@ Create a configuration file at `~/.config/gitsyncer/config.json` (or specify a c
"repo1",
"repo2"
],
+ "showcase_output_dir": "~/git/foo.zone-content/gemtext/about",
+ "showcase_cgit_host": "https://cgit.f3s.buetow.org",
"showcase_stats_branches": {
"foo.zone": "content-gemtext"
}
@@ -453,7 +455,9 @@ Weekly rank snapshots are written on full showcase runs (all repositories), incl
### Configuration
-The showcase output is written to `~/git/foo.zone-content/gemtext/about/showcase.gmi.tpl` by default (currently hardcoded).
+The showcase output defaults to `~/git/foo.zone-content/gemtext/about/showcase.gmi.tpl`. You can override the output directory with `showcase_output_dir`.
+
+cgit links in project sections default to `https://cgit.f3s.buetow.org/<repo>/`. You can override the cgit host with `showcase_cgit_host`.
You can override the branch used for showcase stats and cached code snippets on a per-repository basis with `showcase_stats_branches`. For example, `foo.zone` can use `content-gemtext` while the rest of the repos continue to use their current checkout branch.