diff options
| author | Maria <m5ka+github@posteo.de> | 2024-05-21 19:09:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-21 11:09:28 -0700 |
| commit | d9a9a9071d16c779a390d94666f736e1e96c48dc (patch) | |
| tree | 6d4a677f2fda60ba3c99c08a47d15b559fd739de /README.md | |
| parent | e6df748e5cbb326b77dac6086bff78ac814e1708 (diff) | |
| download | sally-d9a9a9071d16c779a390d94666f736e1e96c48dc.tar.gz | |
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 <jacoboaks.8@gmail.com>
Co-authored-by: r-hang <rhang@uber.com>
Diffstat (limited to '')
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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: |