markdown

Documentation

Index

• Constants
• func BoldText(haystack, needle string) string
• func Linkify(url, text string) string
• func ParseLink(s string) (string, string)
• func RemarkHTML(data PresentationData) string
• func SkypeToMarkdown(input string, stripURLAutoLink bool) string
• func StreamRemarkHTML(qw422016 *qt422016.Writer, data PresentationData)
• 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
• func WriteRemarkHTML(qq422016 qtio422016.Writer, data PresentationData)
• type PresentationData
• type RemarkSlideData
  • func (data *RemarkSlideData) ToRemarkString() 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 RemarkHTML

func RemarkHTML(data PresentationData) string

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 StreamRemarkHTML

func StreamRemarkHTML(qw422016 *qt422016.Writer, data PresentationData)

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

func WriteRemarkHTML

func WriteRemarkHTML(qq422016 qtio422016.Writer, data PresentationData)

Types

type PresentationData

type PresentationData struct {
	Slides []RemarkSlideData
}

type RemarkSlideData

type RemarkSlideData struct {
	Layout   string
	Class    string
	Markdown string
}

func (*RemarkSlideData) ToRemarkString

func (data *RemarkSlideData) ToRemarkString() string