版本说明
当前版本:1.0.0
首个正式发布版本(对应 git tag v1.0.0)。功能集:
- ✅ MD↔源双向块级溯源(点击左栏 MD 块 → 右侧源块滚动居中;点击源块 → 左侧对应块高亮)
- ✅ 自带 PDF 预览外壳:翻页、连续/单页、缩放、缩略图钉住(pin)、QQ 式自动收纳
- ✅ 业务高亮:
addHighlight/setHighlights/clearHighlights/focusBlock - ✅ 版本适配对上层透明:内置
v340适配器,getAdapter自动探测 - ✅ Vue 3 + React 双封装,每个包同时发布 npm(ESM + UMD)与免构建全局版
- ✅ 一套命令式 API:
mount(el, props)+bus事件总线,无框架也能用 - ✅ 真实表格:marked 渲染的 HTML 表格识别为真实
<table>而非代码块
适配的 MinerU 版本
| 项目 | 说明 |
|---|---|
| 适配 MinerU 版本 | 3.4.0(内置 v340 适配器) |
| 支持的源文件类型 | 仅 PDF 与图片 |
WARNING
MinerU 在 PDF 与图片 两种模式下才会返回符合预期的结构与版面坐标(bbox)。其他格式(纯文本、Office 等)暂不纳入适配范围,blockId 映射准确性不做保证。
适配新版本:在 adapters/ 注册新实现(如 v350),getAdapter 会按 meta 自动探测,下游组件与业务代码零改动。
包与产物
| 包 | 形态 | 入口 / 全局 | 构建产物 |
|---|---|---|---|
@mineru-viewer/vue | npm | import / require | dist/mineru-viewer.js (ESM) + dist/mineru-viewer.umd.cjs (UMD) + dist/style.css |
@mineru-viewer/vue-no-esm | 免构建 | 全局 MV | dist/mineru-viewer.js |
@mineru-viewer/react | npm | import / require | dist/mineru-viewer.js (ESM) + dist/mineru-viewer.umd.cjs (UMD) + dist/style.css |
@mineru-viewer/react-no-esm | 免构建 | 全局 MVReact | dist/mineru-viewer.js |
Vue 与 React 由同一份 ESM 源码经 Vite lib 模式构建,逻辑零分叉。
版本号规则
遵循语义化版本(SemVer):
- 主版本(Major):不兼容的 API 变更(如
blockId契约、高亮结构变化) - 次版本(Minor):向后兼容的新功能(如新增适配器版本、新增
emits事件) - 修订(Patch):向后兼容的缺陷修复
已知限制(1.0.0)
- 源文件类型目前覆盖 PDF 与图片(按页切分);
sourceType由适配器探测 - 免构建形态必须显式调用
setPdfWorkerSrc;某些非 Vite 打包环境若 worker 解析失败也需手动设置 blockId稳定性依赖 MinerU 产物本身;若产物重新解析,id 可能变化,业务侧高亮需重新映射
计划中的方向
- 更多 MinerU 版本适配器(按需注册,下游零改动)
- 暗色主题细化与主题变量暴露
- 标注结果导出(与
edit事件配套的回写工具) - 缩略图交互的可配置化(收纳时延、默认透明度)
版本变更会同步更新本页与
CHANGELOG。源码与发布见 GitHub。