markdown

Documentation

Index

• func ConvertMultiLineText(s string) string
• func EscapeIllegalCharacters(s string, settings *settings.Settings) string
• func GenerateIndentation(extra int, settings *settings.Settings) string
• func Sanitize(markdown string) string
• func SanitizeDescription(s string, settings *settings.Settings) string
• func SanitizeDescriptionForTable(s string, settings *settings.Settings) string
• func SanitizeName(s string, settings *settings.Settings) string

Functions

func ConvertMultiLineText

func ConvertMultiLineText(s string) string

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

func EscapeIllegalCharacters

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

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

func GenerateIndentation

func GenerateIndentation(extra int, settings *settings.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 Sanitize

func Sanitize(markdown string) string

Sanitize cleans a Markdown document to soothe linters.

func SanitizeDescription

func SanitizeDescription(s string, settings *settings.Settings) string

func SanitizeDescriptionForTable

func SanitizeDescriptionForTable(s string, settings *settings.Settings) string

SanitizeDescription converts description to suitable Markdown representation for a table. (including line-break, illegal characters, code blocks etc)

func SanitizeName

func SanitizeName(s string, settings *settings.Settings) string

SanitizeName escapes underscore character which have special meaning in Markdown.