From d9a9a9071d16c779a390d94666f736e1e96c48dc Mon Sep 17 00:00:00 2001 From: Maria Date: Tue, 21 May 2024 19:09:28 +0100 Subject: feat: Allow packages to define custom documentation URL and badge (#147) feat: Allow packages to define custom doc URL and badge Co-authored-by: Jacob Oaks Co-authored-by: r-hang --- handler.go | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'handler.go') diff --git a/handler.go b/handler.go index d25ed38..74f6a31 100644 --- a/handler.go +++ b/handler.go @@ -57,13 +57,23 @@ func CreateHandler(config *Config, templates *template.Template) (http.Handler, baseURL = pkg.URL } modulePath := path.Join(baseURL, name) - docURL := "https://" + path.Join(config.Godoc.Host, modulePath) + + docURL := pkg.DocURL + if docURL == "" { + docURL = "https://" + path.Join(config.Godoc.Host, modulePath) + } + + docBadge := pkg.DocBadge + if docBadge == "" { + docBadge = "//pkg.go.dev/badge/" + modulePath + ".svg" + } pkg := &sallyPackage{ Name: name, Desc: pkg.Desc, ModulePath: modulePath, DocURL: docURL, + DocBadge: docBadge, VCS: pkg.VCS, RepoURL: pkg.Repo, } @@ -106,6 +116,9 @@ type sallyPackage struct { // URL at which documentation for the package can be found. DocURL string + // URL at which documentation badge image can be found. + DocBadge string + // Version control system used by the package. VCS string -- cgit v1.2.3