Skip to content

Latest commit

 

History

History
9 lines (5 loc) · 1013 Bytes

README.md

File metadata and controls

9 lines (5 loc) · 1013 Bytes

compose-markdown

This library provides a Jetpack Compose Text component MarkdownText for rendering markdown in a @Composable hierarchy. It follows the Commonmark specification and supports GitHub flavored markdown elements as well.

It uses intellij-markdown under the hood for parsing markdown content into an abstract syntax tree and then uses the AnnotatedString API to display the parsed content onto a Text composable.

In order to display inline content such as images, links, block quotes, checkboxes, etc. this library uses the InlineTextContent API to insert @Composable hierarchies within a Text composable itself.

Check out compose-markdown-demo for examples usages!