summaryrefslogtreecommitdiff
path: root/doc
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 /doc
parent649a41dc0f0cbfa697408db2f006d106ba655933 (diff)
feat(showcase): uq move cgit host and output dir into config
Diffstat (limited to 'doc')
-rw-r--r--doc/api-reference.md2
-rw-r--r--doc/configuration.md28
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/api-reference.md b/doc/api-reference.md
index 7ad41b1..0c9812e 100644
--- a/doc/api-reference.md
+++ b/doc/api-reference.md
@@ -187,6 +187,8 @@ type Config struct {
Organizations []Organization `json:"organizations"` // List of git organizations
Repositories []string `json:"repositories"` // Specific repos to sync
ExcludeBranches []string `json:"exclude_branches"` // Regex patterns for branch exclusion
+ ShowcaseOutputDir string `json:"showcase_output_dir"` // Showcase output directory
+ ShowcaseCgitHost string `json:"showcase_cgit_host"` // Base URL for showcase cgit links
ShowcaseStatsBranches map[string]string `json:"showcase_stats_branches"` // Per-repo branch overrides for showcase stats/code snippets
}
```
diff --git a/doc/configuration.md b/doc/configuration.md
index ce1f917..a8ac398 100644
--- a/doc/configuration.md
+++ b/doc/configuration.md
@@ -38,6 +38,8 @@ GitSyncer looks for configuration files in the following order:
"^temp-",
"-wip$"
],
+ "showcase_output_dir": "~/git/foo.zone-content/gemtext/about",
+ "showcase_cgit_host": "https://cgit.f3s.buetow.org",
"showcase_stats_branches": {
"foo.zone": "content-gemtext"
}
@@ -93,6 +95,30 @@ Example:
}
```
+#### showcase_output_dir (optional)
+Directory where showcase files are written (`showcase.gmi.tpl`, `showcase-rank-history.svg`, and extracted images).
+
+Default: `~/git/foo.zone-content/gemtext/about`
+
+Example:
+```json
+{
+ "showcase_output_dir": "~/git/foo.zone-content/gemtext/about"
+}
+```
+
+#### showcase_cgit_host (optional)
+Base URL used to generate cgit links in showcase project sections.
+
+Default: `https://cgit.f3s.buetow.org`
+
+Example:
+```json
+{
+ "showcase_cgit_host": "https://cgit.example.net/git"
+}
+```
+
## Examples
### Minimal Configuration
@@ -139,6 +165,8 @@ Sync between GitHub and Codeberg:
"-wip$",
"^old-"
],
+ "showcase_output_dir": "~/git/foo.zone-content/gemtext/about",
+ "showcase_cgit_host": "https://cgit.f3s.buetow.org",
"showcase_stats_branches": {
"foo.zone": "content-gemtext"
}