docs: point GoDoc badge to charm.land/glamour/v2 - #583
Open
syf2211 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Update the README GoDoc badge link to point at the v2 module path (
charm.land/glamour/v2) instead of the legacy v1 path (github.com/charmbracelet/glamour).Fixes #581
Motivation
Glamour v2 uses the
charm.land/glamour/v2module path (as shown in the README usage examples andgo.mod), but the GoDoc badge still linked to the v1 package on pkg.go.dev. Clicking the badge took readers to outdated v1 documentation.Changes
hrefinREADME.mdfromhttps://pkg.go.dev/github.com/charmbracelet/glamour?tab=doctohttps://pkg.go.dev/charm.land/glamour/v2Tests
go test ./...— all packages passNotes
Documentation-only change; no code behavior affected.