Compose Markdown View 技术文档

Compose Markdown View 技术文档

MarkdownView-Android Markdown lets you easily display markdown data in android and its compose ready. 项目地址: https://gitcode.com/gh_mirrors/ma/MarkdownView-Android

安装指南

步骤 1: 添加 JitPack 仓库

在项目的根 build.gradle 文件中，添加 JitPack 仓库：

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

步骤 2: 添加依赖

在应用模块的 build.gradle 文件中，添加以下依赖：

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

项目的使用说明

使用 Compose

在需要显示 Markdown 的地方使用 MarkDown 可组合函数：

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

使用旧版视图系统 (XML)

在 XML 文件中添加一个 Compose 视图：

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

然后在 Activity 或 Fragment 中引用并设置 Markdown 内容：

val markdown = findViewById(R.id.markdown)
markdown.composeView.apply {
    // 在视图的 LifecycleOwner 销毁时处理 Composition
    setViewCompositionStrategy(DisposeOnViewTreeLifecycleDestroyed)
    setContent {
       // 在 Compose 世界中
       MaterialTheme {
            MarkDown(
                url = URL("https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md"),
                modifier = Modifier.fillMaxSize()
            )
       }
    }
}

项目API使用文档

Markdown 数据源

项目支持从以下三种不同的数据源读取 Markdown 数据：

1. 文本 (Text)

直接传入 Markdown 内容字符串：

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

2. 文件 (File)

从文件中读取 Markdown 数据：

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

3. URL

从指定的 URL 读取 Markdown 文件：

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

项目安装方式

项目的安装方式已经在“安装指南”部分详细说明。请按照以下步骤操作：

1. 在根 build.gradle 文件中添加 JitPack 仓库。
2. 在应用模块的 build.gradle 文件中添加依赖。

通过以上步骤，您可以成功集成并使用 Compose Markdown View 项目。

MarkdownView-Android Markdown lets you easily display markdown data in android and its compose ready. 项目地址: https://gitcode.com/gh_mirrors/ma/MarkdownView-Android