Method ToHTML

internal/convert/convert.go:407–430

TODO(stapelberg): ToHTML’s output currently is used directly as (html/template).HTML, i.e. “known safe HTML document fragment”. We should be more aggressive in whitelisting the allowed tags. resolve, if non-nil, will be called to resolve a reference (like “rm(1)”) into a URL.

(r io.Reader, resolve func(ref string) string)

// resolve, if non-nil, will be called to resolve a reference (like
// “rm(1)”) into a URL.
func (p *Process) ToHTML(r io.Reader, resolve func(ref string) string) (doc string, toc []string, err error) {
	stdout, stderr, err := p.mandoc(r)
	if stderr != "" {
		return "", nil, fmt.Errorf("mandoc failed: %v", stderr)
	}
	if err != nil {
		return "", nil, fmt.Errorf("running mandoc failed: %v", err)
	}

	parsed, err := html.Parse(strings.NewReader(stdout))
	if err != nil {
		return "", nil, err
	}

	err = recurse(parsed, func(n *html.Node) error { return postprocess(resolve, n, &toc) })
	if err != nil {
		return "", toc, err
	}
	var rendered bytes.Buffer
	if err := html.Render(&rendered, parsed); err != nil {
		return "", toc, err
	}
	return rendered.String(), toc, nil
}