doclinks

package

v1.2.1 Latest Latest Go to latest Published: Sep 11, 2026 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Package doclinks verifies local destinations in Markdown documents.

This section is empty.

This section is empty.

This section is empty.

type BrokenLink struct {
	Source string
	Line   int
	Target string
}

BrokenLink identifies a local destination that does not exist.

func CheckFiles(root string, files []string) ([]BrokenLink, error)

CheckFiles returns local link destinations that do not exist below root.

type Link struct {
	Line        int
	Destination string
}

Link is one Markdown link or image destination.

func Parse(source []byte) ([]Link, error)

Parse returns links from Markdown syntax nodes. It excludes code and raw HTML.