Skip to content

Repository files navigation

提椠 Markdown

Maven Central

提椠 Markdown 是基于提椠的 Markdown 正文渲染库。

提椠 Markdown 在语法节点映射为对应组件之上,进一步处理整篇文章的排版。段落、标题、列表和引用使用提椠的中文断行、标点空间与两端对齐。代码、公式、表格、 图片、图注和脚注则共享统一的版心、间距与样式体系。

渲染器提供文章级的选择与复制、脚注跳转、代码复制和多图浏览。文档模型与 Markdown parser 解耦, 应用可以沿用现有解析器,并保留自有语法和组件。

默认样式跟随 Material 3,也可以自定义。当前仍处于早期开发阶段,支持 Compose Desktop 和 Android 8.1 (API 27) 及以上版本。

使用

implementation("org.tiqian:markdown-compose:<version>")

应用把 Markdown 解析结果转换成 MarkdownRenderDocument 后即可渲染:

TiqianMarkdown(
    document = document,
    onLinkClick = ::openLink,
)

文档转换、自定义样式和图片加载见架构说明

体验与构建

./gradlew jvmTest compileAndroidMain :preview:compileKotlinJvm
./gradlew :preview:run

许可证

Tiqian Markdown 以 Mozilla Public License 2.0 发布。第三方组件与字体见 THIRD_PARTY_NOTICES.md

About

A Markdown text rendering library based on Tíqiàn.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages