feat: Allow packages to define custom documentation URL and badge #147
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
Sally works great in the typical Go documentation ecosystem but when deviating from this it becomes difficult for the documentation badge/URL to be useful, even when specifying a custom
godoc.host
config variable.This pull request aims to give a little more freedom with defining the documentation URL and badge image for different packages.
Changes
doc_url
anddoc_badge
variables to YAML documentation.doc_url
variable when the documentation URL is used in templates, though still generating thehttps://{godoc_host}/{module}
URL as a default.doc_badge
variable as the image to use for a package's badge on the index page, though still generating the//pkg.go.dev/badge/{module}.svg
URL as a default.handler_test.go
).This is a non-breaking feature (semver minor) change. Existing sally setups will continue to work as expected due to these defaults.