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.

Desktop	Android	WebAssembly (Wasm)

• Kotlin Multiplatform — Single codebase for Android, iOS, Desktop, and Web
• Compose Multiplatform — Built on JetBrains Compose Multiplatform
• CommonMark Support — Powered by commonmark-kotlin parser (pure Kotlin Multiplatform)
• Plugin System — Modular plugin architecture for tables, images, HTML, and more; supports custom parser extensions
• Customizable Themes — Full control over typography, colors, and component styles

• Kotlin: 2.0.21+
• Compose Multiplatform: Latest
• Android API: 24+ (Android 7.0)
• Java: 11+

Add the dependency to your project's build.gradle.kts:

// In your shared module's build.gradle.kts
kotlin {
    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation("io.github.feiyin0719:markdown-multiplatform:<version>")
            }
        }
    }
}

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>")
}

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(),
    )
}

For full API signatures and detailed parameter explanations, see the dedicated API document:

• Full API Reference: docs/API.md

We welcome contributions! To get started:

1. Fork the repository
2. Create a feature branch: git checkout -b feat/my-feature
3. Make your changes
4. Format code: ./gradlew ktlintFormat
5. Run checks: ./gradlew ktlintCheck
6. Build: ./gradlew assemble
7. Commit using conventional prefixes (feat:, fix:, docs:, etc.)
8. Open a Pull Request

Released under the MIT License. See LICENSE for details.