mosaic-markdown/org.unitedsoftware.mosaic.markdown

Package-level declarations

Types

@Immutable

class MarkdownTheme(val headings: List<SpanStyle> = listOf( SpanStyle(textStyle = TextStyle.Bold, underlineStyle = UnderlineStyle.Straight), SpanStyle(textStyle = TextStyle.Bold), SpanStyle(textStyle = TextStyle.Bold), SpanStyle(textStyle = TextStyle.Bold + TextStyle.Italic), SpanStyle(textStyle = TextStyle.Italic), SpanStyle(textStyle = TextStyle.Italic + TextStyle.Dim), ), val emphasis: SpanStyle = SpanStyle(textStyle = TextStyle.Italic), val strong: SpanStyle = SpanStyle(textStyle = TextStyle.Bold), val strikethrough: SpanStyle = SpanStyle(textStyle = TextStyle.Strikethrough), val code: SpanStyle = SpanStyle(color = Color(0x61, 0xAF, 0xEF)), val link: SpanStyle = SpanStyle(color = Color(0x61, 0xAF, 0xEF), underlineStyle = UnderlineStyle.Straight), val quoteBar: Color = Color(0x5C, 0x63, 0x70), val quote: SpanStyle = SpanStyle(textStyle = TextStyle.Italic), val bullets: List<String> = listOf("•", "◦", "▪"), val listMarker: SpanStyle = SpanStyle(color = Color(0x5C, 0x63, 0x70)), val checkedTask: String = "☒", val uncheckedTask: String = "☐", val tableBorder: Color = Color(0x5C, 0x63, 0x70), val tableHeader: SpanStyle = SpanStyle(textStyle = TextStyle.Bold), val thematicBreak: Color = Color(0x5C, 0x63, 0x70), val syntax: SyntaxTheme = SyntaxTheme())

The styles Markdown renders with.

SyntaxTheme

@Immutable

class SyntaxTheme(val plain: SpanStyle = SpanStyle(), val keyword: SpanStyle = SpanStyle(color = Color(0xC6, 0x78, 0xDD)), val string: SpanStyle = SpanStyle(color = Color(0x98, 0xC3, 0x79)), val number: SpanStyle = SpanStyle(color = Color(0xD1, 0x9A, 0x66)), val comment: SpanStyle = SpanStyle(color = Color(0x7F, 0x84, 0x8E), textStyle = TextStyle.Italic), val type: SpanStyle = SpanStyle(color = Color(0xE5, 0xC0, 0x7B)), val function: SpanStyle = SpanStyle(color = Color(0x61, 0xAF, 0xEF)), val annotation: SpanStyle = SpanStyle(color = Color(0xE5, 0xC0, 0x7B)), val inserted: SpanStyle = SpanStyle(color = Color(0x98, 0xC3, 0x79)), val deleted: SpanStyle = SpanStyle(color = Color(0xE0, 0x6C, 0x75)), val hunk: SpanStyle = SpanStyle(color = Color(0x56, 0xB6, 0xC2)), val meta: SpanStyle = SpanStyle(textStyle = TextStyle.Dim))

The styles of highlighted code in fenced code blocks.

Functions

Markdown

@Composable

fun Markdown(text: String, modifier: Modifier = Modifier, theme: MarkdownTheme = MarkdownTheme.Default)

Renders the Markdown text: headings, paragraphs with emphasis, code spans, and links (as OSC 8 hyperlinks in terminals which support them), lists including task lists, quotes, fenced code with syntax highlighting, diffs, tables, and thematic breaks.