Compose Markdown View

MarkdownView is a composable library that helps you display Markdown text or files on Android as a html page just like Github.

Supporting Compose Markdown View

Compose Markdown View is an independent project with ongoing development and support made possible thanks to your donations.

• Become a backer

Getting started

Its really simple to integrate Markdown in android. All you need to do make the following change to you build gradle under the app module.

Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url "https://jitpack.io" }
  }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.mukeshsolanki:MarkdownView-Android:2.0.0'
}

How to use Markdown

Its fairly simple and straight forward to use Markdown in you application.

• Using Compose

Just use MarkDown composable where you need to display the view like

MarkDown(
    url = URL("https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md"),
    modifier = Modifier.fillMaxSize()
)

• Using Older View System (aka XML)

Add a compose view in your xml file like

<androidx.compose.ui.platform.ComposeView
    android:id="@+id/markdown"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

and reference it in your activity/fragment and assign the markdown text/file like wise.

val markdown = findViewById(R.id.markdown)
markdown.composeView.apply {
    // Dispose of the Composition when the view's LifecycleOwner is destroyed
    setViewCompositionStrategy(DisposeOnViewTreeLifecycleDestroyed)
    setContent {
       // In Compose world
       MaterialTheme {
            MarkDown(
                url = URL("https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md"),
                modifier = Modifier.fillMaxSize()
            )
       }
    }
}

Markdown Sources

You have 3 different sources from where markdown data can be read

• Text - You can pass the content and string to render the markdown

MarkDown(
    text = "# Test Markdown",
    modifier = Modifier.fillMaxSize()
)

• File - You can read from a file and display the markdown data.

MarkDown(
    file = file,
    modifier = Modifier.fillMaxSize()
)

• URL - You can also specify the url of the markdown file.

MarkDown(
    url = URL("https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md"),
    modifier = Modifier.fillMaxSize()
)

Author

Maintained by Mukesh Solanki

Contribution

• Bug reports and pull requests are welcome.

License

Copyright (c) 2018 Mukesh Solanki

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.