KSLCore/ksl.utilities.io/MarkDown

MarkDown

object MarkDown

A class to facilitate construction of markdown elements

Types

ColFmt

enum ColFmt : Enum<MarkDown.ColFmt>

Table

class Table(colHeaders: List<String>, formats: List<MarkDown.ColFmt> = allSame(colHeaders.size, ColFmt.LEFT))

Properties

D2FORMAT

val D2FORMAT: DecimalFormat

D3FORMAT

val D3FORMAT: DecimalFormat

Functions

allCentered

fun allCentered(nCols: Int): List<MarkDown.ColFmt>

allLeft

fun allLeft(nCols: Int): List<MarkDown.ColFmt>

allRight

fun allRight(nCols: Int): List<MarkDown.ColFmt>

allSame

fun allSame(nCols: Int, format: MarkDown.ColFmt): List<MarkDown.ColFmt>

blockQuote

fun blockQuote(text: String?): String

bold

fun bold(text: String?): String

boldAndItalic

fun boldAndItalic(text: String?): String

code

fun code(text: String?): String

header

fun header(header: String?, hLevel: Int): String

hRule

fun hRule(): String

image

fun image(altText: String?, imageURL: String?): String

italic

fun italic(text: String?): String

link

fun link(linkText: String?, linkURL: String?): String

nList

fun nList(list: List<String?>): String

tableHeader

fun tableHeader(colHeaders: List<String>, formats: List<MarkDown.ColFmt>): String

fun tableHeader(colHeaders: List<String>, format: MarkDown.ColFmt = ColFmt.LEFT): String

tableRow

fun tableRow(elements: List<String>): String

fun tableRow(rowLabel: String? = null, array: DoubleArray, df: DecimalFormat? = D3FORMAT): String

unList

fun unList(list: List<String?>): String