diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api-reference.md | 9 | ||||
| -rw-r--r-- | doc/configuration.md | 22 |
2 files changed, 25 insertions, 6 deletions
diff --git a/doc/api-reference.md b/doc/api-reference.md index cc4f69c..c189e99 100644 --- a/doc/api-reference.md +++ b/doc/api-reference.md @@ -205,9 +205,10 @@ type Organization struct { #### type Config ```go 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 + 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 + ShowcaseStatsBranches map[string]string `json:"showcase_stats_branches"` // Per-repo branch overrides for showcase stats/code snippets } ``` @@ -511,4 +512,4 @@ gitsyncer version 0.1.0 ``` #### func GetShortVersion() string -Returns just the version number: `0.1.0`
\ No newline at end of file +Returns just the version number: `0.1.0` diff --git a/doc/configuration.md b/doc/configuration.md index 25a425f..230cac6 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -37,7 +37,10 @@ GitSyncer looks for configuration files in the following order: "exclude_branches": [ "^temp-", "-wip$" - ] + ], + "showcase_stats_branches": { + "foo.zone": "content-gemtext" + } } ``` @@ -78,6 +81,18 @@ Example: } ``` +#### showcase_stats_branches (optional) +Map of repository names to the branch that should be used when generating showcase statistics and cached code snippets. This is useful when the primary content for a repo lives on a non-default branch. + +Example: +```json +{ + "showcase_stats_branches": { + "foo.zone": "content-gemtext" + } +} +``` + ## Examples ### Minimal Configuration @@ -123,7 +138,10 @@ Sync between GitHub and Codeberg: "^temp-", "-wip$", "^old-" - ] + ], + "showcase_stats_branches": { + "foo.zone": "content-gemtext" + } } ``` |