Compose Markdown Multiplatform
English | 简体中文
A Compose Multiplatform Markdown rendering library that supports Android, iOS, Desktop (JVM), and WebAssembly (Wasm).
Looking for Android-only with richer Markdown compatibility?
Check out ComposeMarkdown — it offers deeper Markdown spec support (powered by Flexmark) and more rendering features for Android projects.
Sample Screenshots
| Desktop | Android | WebAssembly (Wasm) |
|---|
 |  |  |
Features
Supported Platforms
| Platform | Status |
|---|
| Android | Supported |
| iOS (arm64, x64, simulator) |
Installation
System Requirements
- Kotlin: 2.0.21+
- Compose Multiplatform: Latest
- Android API: 24+ (Android 7.0)
- Java: 11+
Add Dependency
Add the dependency to your project's build.gradle.kts:
kotlin {
sourceSets {
val commonMain by getting {
dependencies {
implementation("io.github.feiyin0719:markdown-multiplatform:<version>")
}
}
}
}
Plugin Modules
dependencies {
implementation("io.github.feiyin0719:markdown-multiplatform-table:<version>")
implementation("io.github.feiyin0719:markdown-multiplatform-image:<version>")
implementation("io.github.feiyin0719:markdown-multiplatform-html:<version>")
}
Quick Start
import io.github.feiyin0719.markdown.multiplatform.MarkdownView
@Composable
fun SimpleMarkdownExample() {
val markdownContent = """
# Hello Compose Markdown Multiplatform
This is a **cross-platform** Markdown rendering library.
- Android
- iOS
- Desktop
- Web (Wasm)
""".trimIndent()
MarkdownView(
content = markdownContent,
modifier = Modifier.fillMaxSize(),
)
}
Tech Stack
API Reference
For full API signatures and detailed parameter explanations, see the dedicated API document:
- Full API Reference: docs/API.md
Contributing
We welcome contributions! To get started:
- Fork the repository
- Create a feature branch:
git checkout -b feat/my-feature
License
Released under the MIT License. See LICENSE for details.
Back to top
Made with love by the Compose Markdown team