Search code examples
androidandroid-jetpack-composemarkdown

Display markdown content in Jetpack compose


Currently there's no jetpack compose library for showing md content.

# Header
## H2

` code `
```dsd```
...

How can I make a composable function that can display markdown content?


Solution

  • You can use https://github.com/halilozercan/compose-richtext library. It has a commonmark module that renders markdown content according to commonmark spec.

    Full documentation is available at https://halilibo.com/compose-richtext/richtext-commonmark/

    An example of usage of this library:

    RichText(
      modifier = Modifier.padding(16.dp)
    ) {
      Markdown(
        """
        # Demo
    
        Emphasis, aka italics, with *asterisks* or _underscores_. Strong emphasis, aka bold, with **asterisks** or __underscores__. Combined emphasis with **asterisks and _underscores_**. [Links with two blocks, text in square-brackets, destination is in parentheses.](https://www.example.com). Inline `code` has `back-ticks around` it.
    
        1. First ordered list item
        2. Another item
            * Unordered sub-list.
        3. And another item.
            You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
    
        * Unordered list can use asterisks
        - Or minuses
        + Or pluses
        ---
    
        ```javascript
        var s = "code blocks use monospace font";
        alert(s);
        ```
    
        Markdown | Table | Extension
        --- | --- | ---
        *renders* | `beautiful images` | ![random image](https://picsum.photos/seed/picsum/400/400 "Text 1")
        1 | 2 | 3
    
        > Blockquotes are very handy in email to emulate reply text.
        > This line is part of the same quote.
        """.trimIndent()
      )
    }