harmonyos-md-reader:基于 HarmonyOS ArkTS 的离线 Markdown 阅读器项目

HarmonyOS 离线 Markdown 阅读器:ArkTS 编写,零权限、零网络、零数据收集,支持 Mermaid 离线渲染与手势翻页

Branch1Tags0
FilesLast commitLast update
2 months ago
2 months ago
1 month ago
2 months ago
2 months ago
2 months ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago

harmonyos-md-reader

HarmonyOS(OpenHarmony)平台上的 离线 Markdown 阅读器,ArkTS 编写,零权限、零网络、零数据收集。

一款"小而美"的纯本地 Markdown 阅读应用。打开 .md 文件即可阅读:支持完整 Markdown 语法、手势翻页、表格自适应列宽、Mermaid 图表离线渲染(自带 minified 渲染包)。

✨ 核心特性

  • 🚫 零权限 — 不申请任何敏感权限(无存储、无网络、无位置、无通讯录)
  • 🚫 零网络 — 所有解析、渲染 100% 在设备本地完成
  • 🚫 零数据收集 — 不上报任何使用数据
  • 📝 完整 Markdown — 标题、段落、列表、引用、代码块、分割线、图片、链接、表格
  • 📊 表格自适应 — 列宽自动计算、同行等高、横向滚动
  • 🖐️ 手势操作 — 左右滑动翻页、上滑/下滑滚动
  • 🧜 Mermaid 离线渲染 — ```mermaid 围栏块自带渲染引擎,无须联网
  • 📱 phone 设备 — 目标设备类型:仅手机

📁 项目结构

harmonyos-md-reader/
├── AppScope/              # 应用级配置(包名、版本、图标)
├── entry/                 # 主模块
│   └── src/main/ets/
│       ├── entryability/  # 入口 Ability
│       ├── pages/         # 页面(Index.ets)
│       ├── components/    # 复用组件
│       └── utils/         # 工具类(MarkdownParser 等)
├── design/                # 设计稿与资源
├── hvigor/                # 构建工具
├── hvigorfile.ts          # 构建脚本
├── build-profile.json5    # 构建配置
├── oh-package.json5       # 依赖声明
└── sample.md              # 示例 md 文件(用于自测)

🚀 快速开始

环境要求

  • DevEco Studio 4.0+
  • HarmonyOS SDK API 9+
  • hvigor 构建工具

构建步骤

# 1. 用 DevEco Studio 打开本目录
# 2. 配置签名(不要把 p12 提交到 Git!)
# 3. Build → Build Hap(s) / APP(s) → Build APP(s)

🔐 签名

重要:本仓库不含签名证书。发布版本请在 signing/ 目录配置自己的证书(.p12 / .p7b),并加入 .gitignore。

🧪 自测

# 启动应用 → 打开 "sample.md" → 验证:
# 1. 表格列宽自适应
# 2. Mermaid 块渲染(流程图、时序图等)
# 3. 手势翻页流畅

📜 许可证

📜 许可证 / License

本项目基于 Apache License 2.0 开源 — 详见 LICENSE 与 NOTICE。

Copyright 2026 白志明 (Bai Zhiming)

Introduction

HarmonyOS 离线 Markdown 阅读器:ArkTS 编写,零权限、零网络、零数据收集,支持 Mermaid 离线渲染与手势翻页

Customize your domain