Skip to content

fun-tailor/md_reader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Viewer

一个轻量级的 Android Markdown 阅读工具,专为快速阅读 .md / .markdown 文件设计。
应用本身没有主界面,需要从文件管理器或其他应用通过“打开方式”唤起,适合作为系统级的 Markdown 预览工具。

简单来说,就是个 android 小工具,方便读取 .md 文件,功能简单,将 .md 转成 html,然后调用 webView 来浏览。

✨ 特性

  • 支持 CommonMark 与 GFM(表格、删除线等)解析
  • 纯净白底主题,状态栏与标题栏均为白色,阅读干扰小
  • 标题栏自动显示文档的第一级标题(无标题则留空),长标题自动两行省略
  • 代码块、图片、链接、引用块等常见元素完整渲染
  • 适配浅色/深色系统外观(状态栏图标跟随白色背景强制深色)
  • 最低支持 Android 12(SDK 31),目标 SDK 36

🛠 技术栈

  • 语言:Kotlin
  • UI 框架:Jetpack Compose + Material 3 + WebView
  • 架构:MVVM(ViewModel + StateFlow)
  • Markdown 解析JetBrains Markdown 0.7.3 (GFM 风味)
  • 构建工具:Gradle (Kotlin DSL)

📋 使用方式

  1. 下载并安装应用。
  2. 在任何文件管理器、邮件附件或网页中点击 .md.markdown 文件。
  3. 在“打开方式”列表中选择 Markdown Viewer
  4. 应用会立即解析文件内容并以网页形式展示。

⚠️ 应用不包含内置文件管理器,直接启动图标会显示“Open a .md file to view its content”提示页面。

⚠️ 注意事项

  • 若设备运行 Android 12(API 31)及以下版本,应用需要 READ_EXTERNAL_STORAGE 权限才能读取本地文件。
  • 文件来源支持:
    • 本地文件(file://
    • 内容提供者(content://,如通过文档选择器分享的文件)
    • 远程 HTTPS 链接(https://...,需其他应用传递)
  • 动态颜色功能默认开启(Android 12+ 可用),但状态栏和标题栏被强制设为白色,确保马克飞象式沉浸阅读体验。
  • 本应用仅做预览,不包含编辑、导出或书签功能。

About

简单的 Android Markdown 阅读工具

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages