@datawhale/prosemirror-render

将 ProseMirror / Tiptap 的 JSON 文档（PMNode）渲染为 Vue 3 组件的只读渲染库。

安装

npm install @datawhale/prosemirror-render

使用

import { TreeRender, Media } from "@datawhale/prosemirror-render";

<TreeRender :node="docJson" :axios="httpClient" />

• node：ProseMirror 文档节点（{ type: "doc", content: [...] }）。
• axios：满足 HTTPClientType 接口的 HTTP 客户端，仅在附件 / 视频分析等场景使用，普通文档渲染可传空实现。

本地预览 / 调试

不需要发布即可在浏览器里渲染任意本地 JSON：

npm run dev

打开终端里打印的地址后，可以：

• 点 选择 JSON 文件 从磁盘选一个 .json；
• 直接把 .json 拖拽到画布上；
• 把 JSON 文件放进 dev/samples/，会自动出现在 内置样例 下拉里（支持热更新，改文件即刷新）。

JSON 可以是裸的 doc 节点 { "type": "doc", ... }，也可以是 { "doc": {...} } 包装形式，会自动识别。

相关文件：index.html、dev/main.ts、dev/DevApp.vue。

发布流程

发布只包含 dist（见 package.json 的 "files": ["dist"]），需要先构建。

一次性发布（推荐）

npm run release

它等价于依次执行 npm run bump + npm publish --access public（见下面拆解）。

分步执行

1. 确保工作区干净（npm version 会拒绝有未提交的已跟踪改动）：

   git status        # 应为 clean，否则先 commit / stash

2. 构建 + 升版本 + 打 tag：

   npm run bump

   bump 做了三件事：

   • npm run build：vite build 打包 + vue-tsc 生成类型到 dist/；
   • npm version patch：把 package.json 的版本号 +1（如 0.0.15 → 0.0.16）， 并自动生成一个 commit 和 tag：
     • commit message：release: v0.0.16
     • git tag：v0.0.16
   • postversion 钩子：git push --follow-tags，把这个 commit 和 tag 一起推到 GitHub（origin）。

3. 发布到 npm：

   npm publish --access public

   @datawhale 是 scoped 包，默认私有，必须带 --access public 才能公开发布。

发布前的一次性准备

• 登录 npm，且账号有 @datawhale 组织的发布权限：

  npm whoami        # 确认已登录
  npm login         # 未登录时执行

• GitHub 推送权限：bump 会自动 git push，需保证本地在 main 分支且对 origin （github.com/GYHHAHA/prosemirror-render）有推送权限。

版本号规则

npm version patch 只递增补丁号。如需改次版本 / 主版本，手动指定：

npm run build && npm version minor -m "release: v%s"   # 0.0.x → 0.1.0
npm run build && npm version major -m "release: v%s"   # 0.x.x → 1.0.0

（可选）创建 GitHub Release

bump 只打 git tag。若想在 GitHub 上生成正式的 Release 页面，安装 gh 后：

gh release create v0.0.16 --generate-notes