markdown

Documentation

Index

• Constants
• func BoldText(haystack, needle string) string
• func Linkify(url, text string) string
• func ParseLink(s string) (string, string)
• func SkypeToMarkdown(input string, stripURLAutoLink bool) string
• func TableRowToMarkdown(cells []string, esc bool) string
• func TableRowsToMarkdown(rows [][]string, newline string, esc, withHeader bool) string
• func TableSeparator(cellCount uint) string
• func URLToMarkdownLinkHostname(url string) string
• type Link
  • func (lnk Link) Markdown() string
• type Links
  • func (lnks Links) Texts(condense, dedupe, sortAsc bool) []string

Constants

const (
	GFMTableSep      = "|"
	GFMTableSepStart = GFMTableSep + " "
	GFMTableSepMid   = " " + GFMTableSep + " "
	GFMTableSepEnd   = " " + GFMTableSep
)

Functions

func BoldText

func BoldText(haystack, needle string) string

BoldText bodifies the identified text. It looks for start of words using a word boundary and will arbirarily end to match words with different suffixes.

func Linkify

func Linkify(url, text string) string

Linkify constructs a link from url and text inputs. This function does not handle escaping so it should be done before hand, e.g. using `\[` instead of `[` by itself in the `text`.

func ParseLink

func ParseLink(s string) (string, string)

ParseLink returns text and url.

func SkypeToMarkdown

func SkypeToMarkdown(input string, stripURLAutoLink bool) string

SkypeToMarkdown converts Skype markup to Markdown. This is specifically useful for converting Slack messages to Markdown. The `stripURLAutoLink` parameter will remove links when they are within 3 backticks and the link innerHTML and URL match. Default is `true`.

func TableRowToMarkdown

func TableRowToMarkdown(cells []string, esc bool) string

func TableRowsToMarkdown

func TableRowsToMarkdown(rows [][]string, newline string, esc, withHeader bool) string

func TableSeparator

func TableSeparator(cellCount uint) string

func URLToMarkdownLinkHostname

func URLToMarkdownLinkHostname(url string) string

Types

type Link

type Link struct {
	Text string
	URL  string
}

func (Link) Markdown

func (lnk Link) Markdown() string

type Links

type Links []Link

func (Links) Texts

func (lnks Links) Texts(condense, dedupe, sortAsc bool) []string