format

package

v0.0.0-...-0cf6527 Latest Latest Go to latest Published: Dec 27, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/globekeeper/gomautrix

Links

Open Source Insights

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://spec.matrix.org/v1.2/client-server-api/#mroommessage-msgtypes

Index ¶

Variables
func DefaultPillConverter(displayname, mxid, eventID string, _ Context) string
func Digits(num int) int
func HTMLToContent(html string) event.MessageEventContent
func HTMLToMarkdown(html string) string
func HTMLToText(html string) string
func LongestSequence(in string, of rune) int
func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEventContent
func RenderMarkdownCustom(text string, renderer goldmark.Markdown) event.MessageEventContent
func UnwrapSingleParagraph(html string) string
type CodeBlockConverter
type ColorConverter
type Context
- func NewContext() Context
- func (ctx Context) WithTag(tag string) Context
- func (ctx Context) WithWhitespace() Context
type HTMLParser
- func (parser *HTMLParser) Parse(htmlData string, ctx Context) string
type LinkConverter
type PillConverter
type SpoilerConverter
type TagStack
- func (ts TagStack) Has(tag string) bool
- func (ts TagStack) Index(tag string) int
type TaggedString
type TextConverter

Constants ¶

This section is empty.

Variables ¶

View Source

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

View Source

var Extensions = goldmark.WithExtensions(extension.Strikethrough, extension.Table, mdext.Spoiler)

View Source

var HTMLOptions = goldmark.WithRendererOptions(html.WithHardWraps(), html.WithUnsafe())

Functions ¶

func DefaultPillConverter ¶

func DefaultPillConverter(displayname, mxid, eventID string, _ Context) string

func Digits ¶

func Digits(num int) int

Digits counts the number of digits (and the sign, if negative) in an integer.

func HTMLToContent ¶

func HTMLToContent(html string) event.MessageEventContent

func HTMLToMarkdown ¶

func HTMLToMarkdown(html string) string

HTMLToMarkdown converts Matrix HTML into markdown with the default settings.

Currently, the only difference to HTMLToText is how links are formatted.

func HTMLToText ¶

func HTMLToText(html string) string

HTMLToText converts Matrix HTML into text with the default settings.

func LongestSequence ¶

func LongestSequence(in string, of rune) int

func RenderMarkdown ¶

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

func RenderMarkdownCustom ¶

func RenderMarkdownCustom(text string, renderer goldmark.Markdown) event.MessageEventContent

func UnwrapSingleParagraph ¶

func UnwrapSingleParagraph(html string) string

UnwrapSingleParagraph removes paragraph tags surrounding a string if the string only contains a single paragraph.

Types ¶

type CodeBlockConverter ¶

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

type ColorConverter ¶

type ColorConverter func(text, fg, bg string, ctx Context) string

type Context ¶

type Context struct {
	ReturnData map[string]any
	TagStack   TagStack

	PreserveWhitespace bool
}

func NewContext ¶

func NewContext() Context

func (Context) WithTag ¶

func (ctx Context) WithTag(tag string) Context

func (Context) WithWhitespace ¶

func (ctx Context) WithWhitespace() Context

type HTMLParser ¶

type HTMLParser struct {
	PillConverter           PillConverter
	TabsToSpaces            int
	Newline                 string
	HorizontalLine          string
	BoldConverter           TextConverter
	ItalicConverter         TextConverter
	StrikethroughConverter  TextConverter
	UnderlineConverter      TextConverter
	LinkConverter           LinkConverter
	SpoilerConverter        SpoilerConverter
	ColorConverter          ColorConverter
	MonospaceBlockConverter CodeBlockConverter
	MonospaceConverter      TextConverter
	TextConverter           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 LinkConverter ¶

type LinkConverter func(text, href string, ctx Context) string

type PillConverter ¶

type PillConverter func(displayname, mxid, eventID string, ctx Context) string

type SpoilerConverter ¶

type SpoilerConverter func(text, reason string, ctx Context) string

type TagStack ¶

type TagStack []string

func (TagStack) Has ¶

func (ts TagStack) Has(tag string) bool

func (TagStack) Index ¶

func (ts TagStack) Index(tag string) int

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mdext

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL