agui-markdown/dev.ynagai.agui.markdown

Package-level declarations

Types

class MarkdownAguiTextRenderer(colors: @Composable () -> MarkdownColors = { markdownAguiColors() }, typography: @Composable () -> MarkdownTypography = { markdownAguiTypography() }, flavour: MarkdownFlavourDescriptor = GFMFlavourDescriptor()) : AguiTextRenderer

Draws agent prose as Markdown.

MarkdownAlertColors

@Immutable

class MarkdownAlertColors(val note: Color, val tip: Color, val important: Color, val warning: Color, val caution: Color)

The accent colour of each GFM alert kind -- > [!NOTE] through > [!CAUTION].

MarkdownColors

@Immutable

class MarkdownColors(val text: Color, val codeBackground: Color, val inlineCodeBackground: Color, val dividerColor: Color, val tableBackground: Color, val alert: MarkdownAlertColors)

The colours MarkdownAguiTextRenderer draws with.

MarkdownTypography

@Immutable

class MarkdownTypography(val h1: TextStyle, val h2: TextStyle, val h3: TextStyle, val h4: TextStyle, val h5: TextStyle, val h6: TextStyle, val text: TextStyle, val code: TextStyle, val inlineCode: TextStyle, val quote: TextStyle, val textLink: TextLinkStyles, val table: TextStyle)

The text styles MarkdownAguiTextRenderer draws with.

Functions

markdownAguiColors

fun markdownAguiColors(text: Color = Color.Black, codeBackground: Color = text.copy(alpha = 0.08f), inlineCodeBackground: Color = text.copy(alpha = 0.08f), dividerColor: Color = text.copy(alpha = 0.24f), tableBackground: Color = text.copy(alpha = 0.04f), alert: MarkdownAlertColors = markdownAlertColors(darkTheme = text.luminance() > 0.15f)): MarkdownColors

Markdown colours derived from one text colour.

markdownAguiTypography

fun markdownAguiTypography(base: TextStyle = TextStyle.Default): MarkdownTypography

Markdown typography derived from one text style.

markdownAlertColors

fun markdownAlertColors(darkTheme: Boolean): MarkdownAlertColors

Alert accents in the hues GitHub draws them in, one set for a light surface and one for a dark.