format

Documentation

Overview

Package format contains utilities for working with Matrix HTML, specifically methods to parse Markdown into HTML and to parse Matrix HTML into text or markdown.

https://matrix.org/docs/spec/client_server/r0.6.0#m-room-message-msgtypes

Index

• Variables
• func Digits(num int) int
• func HTMLToText(html string) string
• func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEventContent
• type CodeBlockConverter
• type Context
• type EscapingRenderer
  • func (r *EscapingRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus
• type HTMLParser
  • func (parser *HTMLParser) Parse(htmlData string, ctx Context) string
• type TaggedString
• type TextConverter

Variables

var AntiParagraphRegex = regexp.MustCompile("^<p>(.+?)</p>$")

var BlockTags = []string{"p", "h1", "h2", "h3", "h4", "h5", "h6", "ol", "ul", "pre", "blockquote", "div", "hr", "table"}

var Extensions = blackfriday.WithExtensions(blackfriday.NoIntraEmphasis |
	blackfriday.Tables |
	blackfriday.FencedCode |
	blackfriday.Strikethrough |
	blackfriday.SpaceHeadings |
	blackfriday.DefinitionLists |
	blackfriday.HardLineBreak)

var MatrixToURL = regexp.MustCompile("^(?:https?://)?(?:www\\.)?matrix\\.to/#/([#@!+].*)(?:/(\\$.+))?")

MatrixToURL is the regex for parsing matrix.to URLs. https://matrix.org/docs/spec/appendices#matrix-to-navigation

var NoHTMLRenderer = blackfriday.WithRenderer(&EscapingRenderer{bfhtml})

var Renderer = blackfriday.WithRenderer(bfhtml)

Functions

func Digits

func Digits(num int) int

Digits counts the number of digits in a non-negative integer.

func HTMLToText

func HTMLToText(html string) string

HTMLToText converts Matrix HTML into text with the default settings.

func RenderMarkdown

func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEventContent

Types

type CodeBlockConverter

type CodeBlockConverter func(code, language string, ctx Context) string

type Context

type Context map[string]interface{}

type EscapingRenderer

type EscapingRenderer struct {
	*blackfriday.HTMLRenderer
}

func (*EscapingRenderer) RenderNode

func (r *EscapingRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus

type HTMLParser

type HTMLParser struct {
	PillConverter           func(mxid, eventID string, ctx Context) string
	TabsToSpaces            int
	Newline                 string
	HorizontalLine          string
	BoldConverter           TextConverter
	ItalicConverter         TextConverter
	StrikethroughConverter  TextConverter
	UnderlineConverter      TextConverter
	MonospaceBlockConverter CodeBlockConverter
	MonospaceConverter      TextConverter
}

HTMLParser is a somewhat customizable Matrix HTML parser.

func (*HTMLParser) Parse

func (parser *HTMLParser) Parse(htmlData string, ctx Context) string

Parse converts Matrix HTML into text using the settings in this parser.

type TaggedString

type TaggedString struct {
	// contains filtered or unexported fields
}

TaggedString is a string that also contains a HTML tag.

type TextConverter

type TextConverter func(string, Context) string