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 --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 21f76e1..030bfde 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,18 @@ packages: # # Defaults to the value of the top-level url field. url: example.com + + # Optional URL to the package's documentation. + # + # Defaults to the documentation site at pkg.go.dev with the package's + # module path appended. + doc_url: example.com/go-pkg/docs/zap + + # Optional URL to the badge image which appears in the index page. + # + # Defaults to the badge image at pkg.go.dev, using the package's module + # path followed by .svg as the filename. + doc_badge: example.com/go-pkg/badge/zap ``` Run sally like so: -- cgit v1.2.3