markdown

Documentation

Index

• func ConvertMultiLineText(s string, convertDoubleSpaces bool) string
• func EscapeIllegalCharacters(s string, settings *print.Settings) string
• func GenerateIndentation(extra int, settings *print.Settings) string
• func NormalizeURLs(s string, settings *print.Settings) string
• func PrintFencedCodeBlock(code string, language string) (string, bool)
• func Sanitize(markdown string) string
• func SanitizeItemForDocument(s string, settings *print.Settings) string
• func SanitizeItemForTable(s string, settings *print.Settings) string
• func SanitizeName(name string, settings *print.Settings) string

Functions

func ConvertMultiLineText

func ConvertMultiLineText(s string, convertDoubleSpaces bool) string

ConvertMultiLineText converts a multi-line text into a suitable Markdown representation.

func EscapeIllegalCharacters

func EscapeIllegalCharacters(s string, settings *print.Settings) string

EscapeIllegalCharacters escapes characters which have special meaning in Markdown into their corresponding literal.

func GenerateIndentation

func GenerateIndentation(extra int, settings *print.Settings) string

GenerateIndentation generates indentation of Markdown headers with base level of provided 'settings.MarkdownIndent' plus any extra level needed for subsection (e.g. 'Required Inputs' which is a subsection of 'Inputs' section)

func NormalizeURLs

func NormalizeURLs(s string, settings *print.Settings) string

NormalizeURLs runs after escape function and normalizes URL back to the original state. For example any underscore in the URL which got escaped by 'EscapeIllegalCharacters' will be reverted back.

func PrintFencedCodeBlock

func PrintFencedCodeBlock(code string, language string) (string, bool)

PrintFencedCodeBlock prints codes in fences, it automatically detects if the input 'code' contains '\n' it will use multi line fence, otherwise it wraps the 'code' inside single-tick block. If the fenced is multi-line it also appens an extra '\n` at the end and returns true accordingly, otherwise returns false for non-carriage return.

func Sanitize

func Sanitize(markdown string) string

Sanitize cleans a Markdown document to soothe linters.

func SanitizeItemForDocument

func SanitizeItemForDocument(s string, settings *print.Settings) string

SanitizeItemForDocument converts passed 'string' to suitable Markdown representation for a document. (including line-break, illegal characters, code blocks etc)

func SanitizeItemForTable

func SanitizeItemForTable(s string, settings *print.Settings) string

SanitizeItemForTable converts passed 'string' to suitable Markdown representation for a table. (including line-break, illegal characters, code blocks etc)

func SanitizeName

func SanitizeName(name string, settings *print.Settings) string

SanitizeName escapes underscore character which have special meaning in Markdown.