htmlutil

Documentation

Overview

Package htmlutil provides HTML utilities.

Index

• func MarkdownToHTML(text string) string
• func MarkdownToSafeHTML(text string) safehtml.HTML
• func Split(html []byte) iter.Seq[*Section]
• type Section

Functions

func MarkdownToHTML

func MarkdownToHTML(text string) string

MarkdownToHTML converts trusted markdown text to HTML. For untrusted markdown, use MarkdownToSafeHTML instead.

func MarkdownToSafeHTML

func MarkdownToSafeHTML(text string) safehtml.HTML

MarkdownToSafeHTML converts untrusted markdown text to safe HTML. It escapes any HTML present in the original markdown document before converting the document to HTML.

func Split

func Split(html []byte) iter.Seq[*Section]

Split returns an iterator over sections in html.

Types

type Section

type Section struct {
	Title string // title of heading
	ID    string // anchor ID of heading
	Text  string // text following heading
}

A Section is an HTML document section, which is the text following an HTML heading with an anchor ID.