MD 阅读 · 功能指南
欢迎使用 MD阅读。
这份文档就是应用内置的示例文档,完整展示了它所支持的全部 Markdown 语法与渲染效果。
在微信、QQ 或文件管理器中选中任意
.md文件,选择「用其他应用打开」→ MD阅读,即可快速切换到你自己的文档。
目录
- 一、标题层级
- 二、行内样式
- 三、列表
- 四、引用与分割线
- 五、代码块
- 六、表格
- 七、Mermaid 图形
- 八、分享到云端
- 九、更新日志
一、标题层级
六级标题均有独立的字号与颜色层次,层级越深颜色越浅,阅读时主次分明。
一级标题 H1
二级标题 H2
三级标题 H3
四级标题 H4
五级标题 H5
六级标题 H6
二、行内样式
这是一段普通正文。行内支持 加粗、斜体、_加粗的另一种写法_、行内代码,以及 超链接。
组合用法也很自然:加粗里可以写 代码,斜体里也能放 链接。
中英文混排时,行距与字间距都会自动适配,长段落读起来不累眼。
三、列表
无序列表:
- 轻量、纯净的离线阅读体验
- 支持微信「用其他应用打开」直接唤起
- 预览与源码一键切换
- 表格支持横向滚动,宽表不再被截断
有序列表:
- 打开任意 .md 文件
- 应用自动解析并渲染排版
- 点击「⋮」可切换预览 / 源码 / 全屏
- 点击 Mermaid 图形可进入全屏查看
四、引用与分割线
单段引用:
好的工具应该安静地待在角落,需要时一秒出现,用完就消失。
多段引用(连续多行会被合并为同一块):
第一条:所有解析都在本地完成。 第二条:文档内容不会离开你的手机。 第三条:只有你主动点击「分享到云端」时才会联网。
引用也支持 加粗、行内代码 等行内样式。
五、代码块
ArkTS / TypeScript:
@Entry
@Component
struct Index {
@State mode: string = 'rich';
build() {
Column() {
Text('MD阅读')
.fontSize(18)
.fontWeight(FontWeight.Medium)
}
}
}
Python:
def parse_markdown(src: str) -> list:
lines = src.replace('\r\n', '\n').split('\n')
blocks = []
for line in lines:
if line.startswith('#'):
blocks.append(('heading', line))
return blocks
Bash:
# 构建 release 包
hvigorw assembleApp --mode release -p product=default
# 查看产物
ls -lh build/outputs/default/
SQL:
SELECT uuid, title, access_count, created_at
FROM markdown_share
WHERE access_count > 100
ORDER BY created_at DESC
LIMIT 20;
JSON:
{
"status": "success",
"code": 200,
"result": {
"uuid": "bzj9n3c4PFXlNQ2_McZlCg"
}
}
六、表格
窄表格(自动等分,无需滚动):
| 功能 | 状态 | 说明 |
|---|---|---|
| 标题渲染 | 已支持 | H1 - H6 共 6 级 |
| 表格渲染 | 已支持 | 自动计算列宽 |
| 代码高亮 | 已支持 | 等宽字体 + 灰底 |
| 图形渲染 | 已支持 | Mermaid 离线引擎 |
宽表格(超出屏幕宽度时横向滚动,列宽按内容自适应,不截断):
| 模块 | 语法 | 是否支持 | 渲染方式 | 备注 |
|---|---|---|---|---|
| 标题 | # ~ ###### | 是 | 原生组件 | 六级字号递减 |
| 段落 | 连续文本 | 是 | 原生组件 | 自动合并软换行 |
| 代码块 | 三反引号围栏 | 是 | 原生组件 | 保留原始缩进 |
| 表格 | 竖线分隔 | 是 | 原生组件 | 超宽横向滚动 |
| 图形 | mermaid 围栏 | 是 | Web 渲染 | 离线,不联网 |
| 列表 | - / 1. | 是 | 原生组件 | 支持连续多项 |
| 引用 | > | 是 | 原生组件 | 多行合并为一块 |
| 分割线 | --- | 是 | 原生组件 | 三种写法均可 |
七、Mermaid 图形
所有图形均由应用内置的 Mermaid 引擎离线渲染,不连接任何服务器,也不需要网络。点击图形可进入全屏查看,支持双指缩放。
7.1 流程图(纵向)
flowchart TD
A[收到 .md 文件] --> B{是否已知格式}
B -->|是| C[调用解析器]
B -->|否| D[按纯文本兜底]
C --> E[生成 Block 列表]
D --> E
E --> F[懒加载渲染]
F --> G[展示精美排版]7.2 流程图(横向)
flowchart LR
微信 --> 用其他应用打开 --> MD阅读 --> 渲染
MD阅读 --> 分享到云端 --> 生成短链7.3 时序图
sequenceDiagram
participant U as 用户
participant A as MD阅读
participant S as 分享服务
U->>A: 打开文档
A->>A: 本地解析渲染
U->>A: 点击「分享到云端」
A->>S: POST /markdown/share
S-->>A: 返回 UUID
A-->>U: 展示并复制短链7.4 类图
classDiagram
class Block {
+String type
+render()
}
class Heading {
+int level
}
class Table {
+int[] colWidths
+int minHeight
}
class Mermaid {
+String code
}
Block <|-- Heading
Block <|-- Table
Block <|-- Mermaid7.5 状态图
stateDiagram-v2
[*] --> 未打开
未打开 --> 预览: 打开文档
预览 --> 源码: 切换视图
源码 --> 预览: 切换视图
预览 --> 图形全屏: 点击图形
图形全屏 --> 预览: 返回
预览 --> [*]: 关闭7.6 甘特图
gantt
title 上架进度
dateFormat YYYY-MM-DD
section 开发
需求与原型 :done, a1, 2026-08-25, 3d
编码实现 :done, a2, after a1, 7d
section 上架
发布签名 :done, b1, 2026-09-04, 2d
商店材料 :done, b2, after b1, 3d
备案与审核 :active, b3, after b2, 10d7.7 饼图
pie showData
title 文档元素占比
"正文段落" : 35
"代码块" : 18
"图形" : 22
"表格" : 10
"标题" : 157.8 时间线
timeline
title 版本里程碑
2026-08 : 项目立项 : 完成技术选型
2026-09 : 首个可用版本 : 支持全部基础语法
2026-09 : 图形引擎 : 内置离线 Mermaid
2026-09 : 云端分享 : 一键生成短链八、分享到云端
点击右上角 ⋮ → 分享到云端,即可把当前文档上传到服务器,生成一个可供他人访问的短链。
- 分享链接形如
https://tomarking.com/md/#bzj9n3c4PFXlNQ2_McZlCg - 相同内容的文档会返回同一个链接,重复分享不会产生垃圾数据
- 链接生成后会自动复制,可直接粘贴到微信或浏览器
注意:应用默认完全离线、零权限。只有当你主动点击「分享到云端」时,才会发起一次网络请求,上传的仅为当前文档的标题与正文。
九、更新日志
1.0.0
- 自研 Markdown 解析引擎,支持标题、段落、列表、引用、代码块、表格、分割线
- 内置离线 Mermaid 渲染引擎,流程图、时序图、饼图等一应俱全
- 预览 / 源码双视图切换,支持横竖屏自适应
- 支持从微信等应用「用其他应用打开」直接唤起
- 新增「分享到云端」,一键生成分享短链
本文档为应用内置示例,保存在安装包内,无需联网即可阅读。
有任何建议可发送邮件至 2442***@qq.com。