Method ToMarkdown

tempfork/pkgdoc/pkgdoc.go:55–73

ToMarkdown parses the godoc comment text and writes a Markdown rendering to w suitable for a repository README.md: top-level sections become ## headings without per-heading anchor IDs, and [Symbol] doc links resolve to pkg.go.dev, including for symbols in the current package (which the default print

(w io.Writer, text string)

// including for symbols in the current package (which the default printer would
// otherwise emit as bare #Name fragments with no backing anchor).
func (pkg *Package) ToMarkdown(w io.Writer, text string) {
	d := pkg.doc.Parser().Parse(text)
	pr := pkg.doc.Printer()
	pr.HeadingLevel = 2
	pr.HeadingID = func(*comment.Heading) string { return "" }
	pr.DocLinkBaseURL = "https://pkg.go.dev"
	pr.DocLinkURL = func(link *comment.DocLink) string {
		importPath := link.ImportPath
		if importPath == "" {
			importPath = pkg.doc.ImportPath
		}
		name := link.Name
		if link.Recv != "" {
			name = link.Recv + "." + name
		}
		return "https://pkg.go.dev/" + importPath + "#" + name
	}
	w.Write(pr.Markdown(d))
}

// pkgBuffer is a wrapper for bytes.Buffer that prints a package clause the
// first time Write is called.