markdown

Documentation

Index

• Variables
• func FirstParagraphText(body []byte, doc ast.Node) string
• func WordCountAtLeast(text []byte, want int) bool
• type HeadingInfo
  • func AssignHeaderIDs(body []byte, doc ast.Node) ([]HeadingInfo, error)

Variables

var Markdown = goldmark.New(
	goldmark.WithRendererOptions(html.WithUnsafe()),
	goldmark.WithExtensions(extension.GFM),
	goldmark.WithParserOptions(parser.WithAutoHeadingID()),
)

Functions

func FirstParagraphText

func FirstParagraphText(body []byte, doc ast.Node) string

FirstParagraphText returns the plain text of the first paragraph in a document. If there's anything but headings or html comments before such a paragraph, it returns an empty string.

func WordCountAtLeast

func WordCountAtLeast(text []byte, want int) bool

Types

type HeadingInfo

type HeadingInfo struct {
	Text, Slug string
	Level      int
}

func AssignHeaderIDs

func AssignHeaderIDs(body []byte, doc ast.Node) ([]HeadingInfo, error)